From 15a609d5d6613e37e819975ceba01cb5ba735242 Mon Sep 17 00:00:00 2001 From: gluk256 Date: Tue, 14 Feb 2017 15:44:47 +0100 Subject: whisper: interface changed to simplify the transition to v5 * whisper: mailserver test introduced, refactoring * whisper: validation test updated * whisper: max number of peers fixed * whisper: verification bug fixed * whisper: esthetic fix * whisper: interface changed to simplify the transition to v5 * whisper: preparation for version switch --- cmd/wnode/main.go | 5 +- mobile/geth.go | 4 +- whisper/mailserver/server_test.go | 4 +- whisper/shhapi/api.go | 478 ------------------------------- whisper/shhapi/api_test.go | 571 ------------------------------------- whisper/whisperv5/api.go | 463 ++++++++++++++++++++++++++++++ whisper/whisperv5/api_test.go | 573 ++++++++++++++++++++++++++++++++++++++ whisper/whisperv5/filter_test.go | 4 +- whisper/whisperv5/peer_test.go | 2 +- whisper/whisperv5/whisper.go | 20 +- whisper/whisperv5/whisper_test.go | 8 +- 11 files changed, 1069 insertions(+), 1063 deletions(-) delete mode 100644 whisper/shhapi/api.go delete mode 100644 whisper/shhapi/api_test.go create mode 100644 whisper/whisperv5/api.go create mode 100644 whisper/whisperv5/api_test.go diff --git a/cmd/wnode/main.go b/cmd/wnode/main.go index 55565eab2..175021798 100644 --- a/cmd/wnode/main.go +++ b/cmd/wnode/main.go @@ -198,10 +198,11 @@ func initialize() { utils.Fatalf("Failed to read Mail Server password: %s", err) } } - shh = whisper.NewWhisper(&mailServer) + shh = whisper.New() + shh.RegisterServer(&mailServer) mailServer.Init(shh, *argDBPath, msPassword, *argServerPoW) } else { - shh = whisper.NewWhisper(nil) + shh = whisper.New() } asymKey = shh.NewIdentity() diff --git a/mobile/geth.go b/mobile/geth.go index af0054cdc..52c6986fb 100644 --- a/mobile/geth.go +++ b/mobile/geth.go @@ -32,7 +32,7 @@ import ( "github.com/ethereum/go-ethereum/node" "github.com/ethereum/go-ethereum/p2p/nat" "github.com/ethereum/go-ethereum/params" - "github.com/ethereum/go-ethereum/whisper/whisperv2" + whisper "github.com/ethereum/go-ethereum/whisper/whisperv2" ) // NodeConfig represents the collection of configuration values to fine tune the Geth @@ -172,7 +172,7 @@ func NewNode(datadir string, config *NodeConfig) (stack *Node, _ error) { } // Register the Whisper protocol if requested if config.WhisperEnabled { - if err := rawStack.Register(func(*node.ServiceContext) (node.Service, error) { return whisperv2.New(), nil }); err != nil { + if err := rawStack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil { return nil, fmt.Errorf("whisper init: %v", err) } } diff --git a/whisper/mailserver/server_test.go b/whisper/mailserver/server_test.go index 24abf6c1a..02b30ff5e 100644 --- a/whisper/mailserver/server_test.go +++ b/whisper/mailserver/server_test.go @@ -84,7 +84,9 @@ func TestMailServer(t *testing.T) { } var server WMailServer - shh = whisper.NewWhisper(&server) + shh = whisper.New() + shh.RegisterServer(&server) + server.Init(shh, dbPath, password, powRequirement) defer server.Close() diff --git a/whisper/shhapi/api.go b/whisper/shhapi/api.go deleted file mode 100644 index b273053ec..000000000 --- a/whisper/shhapi/api.go +++ /dev/null @@ -1,478 +0,0 @@ -// Copyright 2016 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 . - -package shhapi - -import ( - "encoding/json" - "errors" - "fmt" - mathrand "math/rand" - - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/common/hexutil" - "github.com/ethereum/go-ethereum/crypto" - "github.com/ethereum/go-ethereum/logger" - "github.com/ethereum/go-ethereum/logger/glog" - "github.com/ethereum/go-ethereum/rpc" - "github.com/ethereum/go-ethereum/whisper/whisperv5" -) - -var whisperOffLineErr = errors.New("whisper is offline") - -// PublicWhisperAPI provides the whisper RPC service. -type PublicWhisperAPI struct { - whisper *whisperv5.Whisper -} - -// NewPublicWhisperAPI create a new RPC whisper service. -func NewPublicWhisperAPI() *PublicWhisperAPI { - w := whisperv5.NewWhisper(nil) - return &PublicWhisperAPI{whisper: w} -} - -// APIs returns the RPC descriptors the Whisper implementation offers -func APIs() []rpc.API { - return []rpc.API{ - { - Namespace: whisperv5.ProtocolName, - Version: whisperv5.ProtocolVersionStr, - Service: NewPublicWhisperAPI(), - Public: true, - }, - } -} - -// Start starts the Whisper worker threads. -func (api *PublicWhisperAPI) Start() error { - if api.whisper == nil { - return whisperOffLineErr - } - return api.whisper.Start(nil) -} - -// Stop stops the Whisper worker threads. -func (api *PublicWhisperAPI) Stop() error { - if api.whisper == nil { - return whisperOffLineErr - } - return api.whisper.Stop() -} - -// Version returns the Whisper version this node offers. -func (api *PublicWhisperAPI) Version() (hexutil.Uint, error) { - if api.whisper == nil { - return 0, whisperOffLineErr - } - return hexutil.Uint(api.whisper.Version()), nil -} - -// MarkPeerTrusted marks specific peer trusted, which will allow it -// to send historic (expired) messages. -func (api *PublicWhisperAPI) MarkPeerTrusted(peerID hexutil.Bytes) error { - if api.whisper == nil { - return whisperOffLineErr - } - return api.whisper.MarkPeerTrusted(peerID) -} - -// RequestHistoricMessages requests the peer to deliver the old (expired) messages. -// data contains parameters (time frame, payment details, etc.), required -// by the remote email-like server. Whisper is not aware about the data format, -// it will just forward the raw data to the server. -//func (api *PublicWhisperAPI) RequestHistoricMessages(peerID hexutil.Bytes, data hexutil.Bytes) error { -// if api.whisper == nil { -// return whisperOffLineErr -// } -// return api.whisper.RequestHistoricMessages(peerID, data) -//} - -// HasIdentity checks if the whisper node is configured with the private key -// of the specified public pair. -func (api *PublicWhisperAPI) HasIdentity(identity string) (bool, error) { - if api.whisper == nil { - return false, whisperOffLineErr - } - return api.whisper.HasIdentity(identity), nil -} - -// DeleteIdentity deletes the specifies key if it exists. -func (api *PublicWhisperAPI) DeleteIdentity(identity string) error { - if api.whisper == nil { - return whisperOffLineErr - } - api.whisper.DeleteIdentity(identity) - return nil -} - -// NewIdentity generates a new cryptographic identity for the client, and injects -// it into the known identities for message decryption. -func (api *PublicWhisperAPI) NewIdentity() (string, error) { - if api.whisper == nil { - return "", whisperOffLineErr - } - identity := api.whisper.NewIdentity() - return common.ToHex(crypto.FromECDSAPub(&identity.PublicKey)), nil -} - -// GenerateSymKey generates a random symmetric key and stores it under -// the 'name' id. Will be used in the future for session key exchange. -func (api *PublicWhisperAPI) GenerateSymKey(name string) error { - if api.whisper == nil { - return whisperOffLineErr - } - return api.whisper.GenerateSymKey(name) -} - -// AddSymKey stores the key under the 'name' id. -func (api *PublicWhisperAPI) AddSymKey(name string, key []byte) error { - if api.whisper == nil { - return whisperOffLineErr - } - return api.whisper.AddSymKey(name, key) -} - -// HasSymKey returns true if there is a key associated with the name string. -// Otherwise returns false. -func (api *PublicWhisperAPI) HasSymKey(name string) (bool, error) { - if api.whisper == nil { - return false, whisperOffLineErr - } - res := api.whisper.HasSymKey(name) - return res, nil -} - -// DeleteSymKey deletes the key associated with the name string if it exists. -func (api *PublicWhisperAPI) DeleteSymKey(name string) error { - if api.whisper == nil { - return whisperOffLineErr - } - api.whisper.DeleteSymKey(name) - return nil -} - -// NewWhisperFilter creates and registers a new message filter to watch for inbound whisper messages. -// Returns the ID of the newly created Filter. -func (api *PublicWhisperAPI) NewFilter(args WhisperFilterArgs) (uint32, error) { - if api.whisper == nil { - return 0, whisperOffLineErr - } - - filter := whisperv5.Filter{ - Src: crypto.ToECDSAPub(common.FromHex(args.From)), - KeySym: api.whisper.GetSymKey(args.KeyName), - PoW: args.PoW, - Messages: make(map[common.Hash]*whisperv5.ReceivedMessage), - AcceptP2P: args.AcceptP2P, - } - if len(filter.KeySym) > 0 { - filter.SymKeyHash = crypto.Keccak256Hash(filter.KeySym) - } - filter.Topics = append(filter.Topics, args.Topics...) - - if len(args.Topics) == 0 { - info := "NewFilter: at least one topic must be specified" - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - - if len(args.KeyName) != 0 && len(filter.KeySym) == 0 { - info := "NewFilter: key was not found by name: " + args.KeyName - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - - if len(args.To) == 0 && len(filter.KeySym) == 0 { - info := "NewFilter: filter must contain either symmetric or asymmetric key" - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - - if len(args.To) != 0 && len(filter.KeySym) != 0 { - info := "NewFilter: filter must not contain both symmetric and asymmetric key" - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - - if len(args.To) > 0 { - dst := crypto.ToECDSAPub(common.FromHex(args.To)) - if !whisperv5.ValidatePublicKey(dst) { - info := "NewFilter: Invalid 'To' address" - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - filter.KeyAsym = api.whisper.GetIdentity(string(args.To)) - if filter.KeyAsym == nil { - info := "NewFilter: non-existent identity provided" - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - } - - if len(args.From) > 0 { - if !whisperv5.ValidatePublicKey(filter.Src) { - info := "NewFilter: Invalid 'From' address" - glog.V(logger.Error).Infof(info) - return 0, errors.New(info) - } - } - - id := api.whisper.Watch(&filter) - return id, nil -} - -// UninstallFilter disables and removes an existing filter. -func (api *PublicWhisperAPI) UninstallFilter(filterId uint32) { - api.whisper.Unwatch(filterId) -} - -// GetFilterChanges retrieves all the new messages matched by a filter since the last retrieval. -func (api *PublicWhisperAPI) GetFilterChanges(filterId uint32) []WhisperMessage { - f := api.whisper.GetFilter(filterId) - if f != nil { - newMail := f.Retrieve() - return toWhisperMessages(newMail) - } - return toWhisperMessages(nil) -} - -// GetMessages retrieves all the known messages that match a specific filter. -func (api *PublicWhisperAPI) GetMessages(filterId uint32) []WhisperMessage { - all := api.whisper.Messages(filterId) - return toWhisperMessages(all) -} - -// toWhisperMessages converts a Whisper message to a RPC whisper message. -func toWhisperMessages(messages []*whisperv5.ReceivedMessage) []WhisperMessage { - msgs := make([]WhisperMessage, len(messages)) - for i, msg := range messages { - msgs[i] = NewWhisperMessage(msg) - } - return msgs -} - -// Post creates a whisper message and injects it into the network for distribution. -func (api *PublicWhisperAPI) Post(args PostArgs) error { - if api.whisper == nil { - return whisperOffLineErr - } - - params := whisperv5.MessageParams{ - TTL: args.TTL, - Dst: crypto.ToECDSAPub(common.FromHex(args.To)), - KeySym: api.whisper.GetSymKey(args.KeyName), - Topic: args.Topic, - Payload: args.Payload, - Padding: args.Padding, - WorkTime: args.WorkTime, - PoW: args.PoW, - } - - if len(args.From) > 0 { - pub := crypto.ToECDSAPub(common.FromHex(args.From)) - if !whisperv5.ValidatePublicKey(pub) { - info := "Post: Invalid 'From' address" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - params.Src = api.whisper.GetIdentity(string(args.From)) - if params.Src == nil { - info := "Post: non-existent identity provided" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - } - - filter := api.whisper.GetFilter(args.FilterID) - if filter == nil && args.FilterID > 0 { - info := fmt.Sprintf("Post: wrong filter id %d", args.FilterID) - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - - if filter != nil { - // get the missing fields from the filter - if params.KeySym == nil && filter.KeySym != nil { - params.KeySym = filter.KeySym - } - if params.Src == nil && filter.Src != nil { - params.Src = filter.KeyAsym - } - if (params.Topic == whisperv5.TopicType{}) { - sz := len(filter.Topics) - if sz < 1 { - info := fmt.Sprintf("Post: no topics in filter # %d", args.FilterID) - glog.V(logger.Error).Infof(info) - return errors.New(info) - } else if sz == 1 { - params.Topic = filter.Topics[0] - } else { - // choose randomly - rnd := mathrand.Intn(sz) - params.Topic = filter.Topics[rnd] - } - } - } - - // validate - if len(args.KeyName) != 0 && len(params.KeySym) == 0 { - info := "Post: key was not found by name: " + args.KeyName - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - - if len(args.To) == 0 && len(params.KeySym) == 0 { - info := "Post: message must be encrypted either symmetrically or asymmetrically" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - - if len(args.To) != 0 && len(params.KeySym) != 0 { - info := "Post: ambigous encryption method requested" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - - if len(args.To) > 0 { - if !whisperv5.ValidatePublicKey(params.Dst) { - info := "Post: Invalid 'To' address" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - } - - // encrypt and send - message := whisperv5.NewSentMessage(¶ms) - envelope, err := message.Wrap(¶ms) - if err != nil { - glog.V(logger.Error).Infof(err.Error()) - return err - } - if len(envelope.Data) > whisperv5.MaxMessageLength { - info := "Post: message is too big" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - if (envelope.Topic == whisperv5.TopicType{} && envelope.IsSymmetric()) { - info := "Post: topic is missing for symmetric encryption" - glog.V(logger.Error).Infof(info) - return errors.New(info) - } - - if args.PeerID != nil { - return api.whisper.SendP2PMessage(args.PeerID, envelope) - } - - return api.whisper.Send(envelope) -} - -type PostArgs struct { - TTL uint32 `json:"ttl"` - From string `json:"from"` - To string `json:"to"` - KeyName string `json:"keyname"` - Topic whisperv5.TopicType `json:"topic"` - Padding hexutil.Bytes `json:"padding"` - Payload hexutil.Bytes `json:"payload"` - WorkTime uint32 `json:"worktime"` - PoW float64 `json:"pow"` - FilterID uint32 `json:"filterID"` - PeerID hexutil.Bytes `json:"peerID"` -} - -type WhisperFilterArgs struct { - To string - From string - KeyName string - PoW float64 - Topics []whisperv5.TopicType - AcceptP2P bool -} - -// UnmarshalJSON implements the json.Unmarshaler interface, invoked to convert a -// JSON message blob into a WhisperFilterArgs structure. -func (args *WhisperFilterArgs) UnmarshalJSON(b []byte) (err error) { - // Unmarshal the JSON message and sanity check - var obj struct { - To string `json:"to"` - From string `json:"from"` - KeyName string `json:"keyname"` - PoW float64 `json:"pow"` - Topics []interface{} `json:"topics"` - AcceptP2P bool `json:"acceptP2P"` - } - if err := json.Unmarshal(b, &obj); err != nil { - return err - } - - args.To = obj.To - args.From = obj.From - args.KeyName = obj.KeyName - args.PoW = obj.PoW - args.AcceptP2P = obj.AcceptP2P - - // Construct the topic array - if obj.Topics != nil { - topics := make([]string, len(obj.Topics)) - for i, field := range obj.Topics { - switch value := field.(type) { - case string: - topics[i] = value - case nil: - return fmt.Errorf("topic[%d] is empty", i) - default: - return fmt.Errorf("topic[%d] is not a string", i) - } - } - topicsDecoded := make([]whisperv5.TopicType, len(topics)) - for j, s := range topics { - x := common.FromHex(s) - if x == nil || len(x) != whisperv5.TopicLength { - return fmt.Errorf("topic[%d] is invalid", j) - } - topicsDecoded[j] = whisperv5.BytesToTopic(x) - } - args.Topics = topicsDecoded - } - - return nil -} - -// WhisperMessage is the RPC representation of a whisper message. -type WhisperMessage struct { - Payload string `json:"payload"` - Padding string `json:"padding"` - From string `json:"from"` - To string `json:"to"` - Sent uint32 `json:"sent"` - TTL uint32 `json:"ttl"` - PoW float64 `json:"pow"` - Hash string `json:"hash"` -} - -// NewWhisperMessage converts an internal message into an API version. -func NewWhisperMessage(message *whisperv5.ReceivedMessage) WhisperMessage { - return WhisperMessage{ - Payload: common.ToHex(message.Payload), - Padding: common.ToHex(message.Padding), - From: common.ToHex(crypto.FromECDSAPub(message.SigToPubKey())), - To: common.ToHex(crypto.FromECDSAPub(message.Dst)), - Sent: message.Sent, - TTL: message.TTL, - PoW: message.PoW, - Hash: common.ToHex(message.EnvelopeHash.Bytes()), - } -} diff --git a/whisper/shhapi/api_test.go b/whisper/shhapi/api_test.go deleted file mode 100644 index 60b6fbd04..000000000 --- a/whisper/shhapi/api_test.go +++ /dev/null @@ -1,571 +0,0 @@ -// Copyright 2016 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 . - -package shhapi - -import ( - "bytes" - "testing" - "time" - - "encoding/json" - - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/whisper/whisperv5" -) - -func TestBasic(t *testing.T) { - var id string = "test" - api := NewPublicWhisperAPI() - if api == nil { - t.Fatalf("failed to create API.") - } - - ver, err := api.Version() - if err != nil { - t.Fatalf("failed generateFilter: %s.", err) - } - - if uint64(ver) != whisperv5.ProtocolVersion { - t.Fatalf("wrong version: %d.", ver) - } - - mail := api.GetFilterChanges(1) - if len(mail) != 0 { - t.Fatalf("failed GetFilterChanges: premature result") - } - - exist, err := api.HasIdentity(id) - if err != nil { - t.Fatalf("failed initial HasIdentity: %s.", err) - } - if exist { - t.Fatalf("failed initial HasIdentity: false positive.") - } - - err = api.DeleteIdentity(id) - if err != nil { - t.Fatalf("failed DeleteIdentity: %s.", err) - } - - pub, err := api.NewIdentity() - if err != nil { - t.Fatalf("failed NewIdentity: %s.", err) - } - if len(pub) == 0 { - t.Fatalf("failed NewIdentity: empty") - } - - exist, err = api.HasIdentity(pub) - if err != nil { - t.Fatalf("failed HasIdentity: %s.", err) - } - if !exist { - t.Fatalf("failed HasIdentity: false negative.") - } - - err = api.DeleteIdentity(pub) - if err != nil { - t.Fatalf("failed to delete second identity: %s.", err) - } - - exist, err = api.HasIdentity(pub) - if err != nil { - t.Fatalf("failed HasIdentity(): %s.", err) - } - if exist { - t.Fatalf("failed HasIdentity(): false positive.") - } - - id = "arbitrary text" - id2 := "another arbitrary string" - - exist, err = api.HasSymKey(id) - if err != nil { - t.Fatalf("failed HasSymKey: %s.", err) - } - if exist { - t.Fatalf("failed HasSymKey: false positive.") - } - - err = api.GenerateSymKey(id) - if err != nil { - t.Fatalf("failed GenerateSymKey: %s.", err) - } - - exist, err = api.HasSymKey(id) - if err != nil { - t.Fatalf("failed HasSymKey(): %s.", err) - } - if !exist { - t.Fatalf("failed HasSymKey(): false negative.") - } - - err = api.AddSymKey(id, []byte("some stuff here")) - if err == nil { - t.Fatalf("failed AddSymKey: %s.", err) - } - - err = api.AddSymKey(id2, []byte("some stuff here")) - if err != nil { - t.Fatalf("failed AddSymKey: %s.", err) - } - - exist, err = api.HasSymKey(id2) - if err != nil { - t.Fatalf("failed HasSymKey(id2): %s.", err) - } - if !exist { - t.Fatalf("failed HasSymKey(id2): false negative.") - } - - err = api.DeleteSymKey(id) - if err != nil { - t.Fatalf("failed DeleteSymKey(id): %s.", err) - } - - exist, err = api.HasSymKey(id) - if err != nil { - t.Fatalf("failed HasSymKey(id): %s.", err) - } - if exist { - t.Fatalf("failed HasSymKey(id): false positive.") - } -} - -func TestUnmarshalFilterArgs(t *testing.T) { - s := []byte(`{ - "to":"0x70c87d191324e6712a591f304b4eedef6ad9bb9d", - "from":"0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", - "keyname":"testname", - "pow":2.34, - "topics":["0x00000000", "0x007f80ff", "0xff807f00", "0xf26e7779"], - "acceptP2P":true - }`) - - var f WhisperFilterArgs - err := f.UnmarshalJSON(s) - if err != nil { - t.Fatalf("failed UnmarshalJSON: %s.", err) - } - - if f.To != "0x70c87d191324e6712a591f304b4eedef6ad9bb9d" { - t.Fatalf("wrong To: %x.", f.To) - } - if f.From != "0x9b2055d370f73ec7d8a03e965129118dc8f5bf83" { - t.Fatalf("wrong From: %x.", f.To) - } - if f.KeyName != "testname" { - t.Fatalf("wrong KeyName: %s.", f.KeyName) - } - if f.PoW != 2.34 { - t.Fatalf("wrong pow: %f.", f.PoW) - } - if !f.AcceptP2P { - t.Fatalf("wrong AcceptP2P: %v.", f.AcceptP2P) - } - if len(f.Topics) != 4 { - t.Fatalf("wrong topics number: %d.", len(f.Topics)) - } - - i := 0 - if f.Topics[i] != (whisperv5.TopicType{0x00, 0x00, 0x00, 0x00}) { - t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) - } - - i++ - if f.Topics[i] != (whisperv5.TopicType{0x00, 0x7f, 0x80, 0xff}) { - t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) - } - - i++ - if f.Topics[i] != (whisperv5.TopicType{0xff, 0x80, 0x7f, 0x00}) { - t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) - } - - i++ - if f.Topics[i] != (whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79}) { - t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) - } -} - -func TestUnmarshalPostArgs(t *testing.T) { - s := []byte(`{ - "ttl":12345, - "from":"0x70c87d191324e6712a591f304b4eedef6ad9bb9d", - "to":"0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", - "keyname":"shh_test", - "topic":"0xf26e7779", - "padding":"0x74686973206973206D79207465737420737472696E67", - "payload":"0x7061796C6F61642073686F756C642062652070736575646F72616E646F6D", - "worktime":777, - "pow":3.1416, - "filterID":64, - "peerID":"0xf26e7779" - }`) - - var a PostArgs - err := json.Unmarshal(s, &a) - if err != nil { - t.Fatalf("failed UnmarshalJSON: %s.", err) - } - - if a.TTL != 12345 { - t.Fatalf("wrong ttl: %d.", a.TTL) - } - if a.From != "0x70c87d191324e6712a591f304b4eedef6ad9bb9d" { - t.Fatalf("wrong From: %x.", a.To) - } - if a.To != "0x9b2055d370f73ec7d8a03e965129118dc8f5bf83" { - t.Fatalf("wrong To: %x.", a.To) - } - if a.KeyName != "shh_test" { - t.Fatalf("wrong KeyName: %s.", a.KeyName) - } - if a.Topic != (whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79}) { - t.Fatalf("wrong topic: %x.", a.Topic) - } - if string(a.Padding) != "this is my test string" { - t.Fatalf("wrong Padding: %s.", string(a.Padding)) - } - if string(a.Payload) != "payload should be pseudorandom" { - t.Fatalf("wrong Payload: %s.", string(a.Payload)) - } - if a.WorkTime != 777 { - t.Fatalf("wrong WorkTime: %d.", a.WorkTime) - } - if a.PoW != 3.1416 { - t.Fatalf("wrong pow: %f.", a.PoW) - } - if a.FilterID != 64 { - t.Fatalf("wrong FilterID: %d.", a.FilterID) - } - if !bytes.Equal(a.PeerID[:], a.Topic[:]) { - t.Fatalf("wrong PeerID: %x.", a.PeerID) - } -} - -func waitForMessage(api *PublicWhisperAPI, id uint32, target int) bool { - for i := 0; i < 64; i++ { - all := api.GetMessages(id) - if len(all) >= target { - return true - } - time.Sleep(time.Millisecond * 16) - } - - // timeout 1024 milliseconds - return false -} - -func TestIntegrationAsym(t *testing.T) { - api := NewPublicWhisperAPI() - if api == nil { - t.Fatalf("failed to create API.") - } - - api.Start() - defer api.Stop() - - sig, err := api.NewIdentity() - if err != nil { - t.Fatalf("failed NewIdentity: %s.", err) - } - if len(sig) == 0 { - t.Fatalf("wrong signature") - } - - exist, err := api.HasIdentity(sig) - if err != nil { - t.Fatalf("failed HasIdentity: %s.", err) - } - if !exist { - t.Fatalf("failed HasIdentity: false negative.") - } - - key, err := api.NewIdentity() - if err != nil { - t.Fatalf("failed NewIdentity(): %s.", err) - } - if len(key) == 0 { - t.Fatalf("wrong key") - } - - var topics [2]whisperv5.TopicType - topics[0] = whisperv5.TopicType{0x00, 0x64, 0x00, 0xff} - topics[1] = whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79} - var f WhisperFilterArgs - f.To = key - f.From = sig - f.Topics = topics[:] - f.PoW = whisperv5.MinimumPoW / 2 - f.AcceptP2P = true - - id, err := api.NewFilter(f) - if err != nil { - t.Fatalf("failed to create new filter: %s.", err) - } - - var p PostArgs - p.TTL = 2 - p.From = f.From - p.To = f.To - p.Padding = []byte("test string") - p.Payload = []byte("extended test string") - p.PoW = whisperv5.MinimumPoW - p.Topic = whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79} - p.WorkTime = 2 - - err = api.Post(p) - if err != nil { - t.Errorf("failed to post message: %s.", err) - } - - ok := waitForMessage(api, id, 1) - if !ok { - t.Fatalf("failed to receive first message: timeout.") - } - - mail := api.GetFilterChanges(id) - if len(mail) != 1 { - t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) - } - - text := string(common.FromHex(mail[0].Payload)) - if text != string("extended test string") { - t.Fatalf("failed to decrypt first message: %s.", text) - } - - p.Padding = []byte("new value") - p.Payload = []byte("extended new value") - err = api.Post(p) - if err != nil { - t.Fatalf("failed to post next message: %s.", err) - } - - ok = waitForMessage(api, id, 2) - if !ok { - t.Fatalf("failed to receive second message: timeout.") - } - - mail = api.GetFilterChanges(id) - if len(mail) != 1 { - t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) - } - - text = string(common.FromHex(mail[0].Payload)) - if text != string("extended new value") { - t.Fatalf("failed to decrypt second message: %s.", text) - } -} - -func TestIntegrationSym(t *testing.T) { - api := NewPublicWhisperAPI() - if api == nil { - t.Fatalf("failed to create API.") - } - - api.Start() - defer api.Stop() - - keyname := "schluessel" - err := api.GenerateSymKey(keyname) - if err != nil { - t.Fatalf("failed GenerateSymKey: %s.", err) - } - - sig, err := api.NewIdentity() - if err != nil { - t.Fatalf("failed NewIdentity: %s.", err) - } - if len(sig) == 0 { - t.Fatalf("wrong signature") - } - - exist, err := api.HasIdentity(sig) - if err != nil { - t.Fatalf("failed HasIdentity: %s.", err) - } - if !exist { - t.Fatalf("failed HasIdentity: false negative.") - } - - var topics [2]whisperv5.TopicType - topics[0] = whisperv5.TopicType{0x00, 0x7f, 0x80, 0xff} - topics[1] = whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79} - var f WhisperFilterArgs - f.KeyName = keyname - f.Topics = topics[:] - f.PoW = 0.324 - f.From = sig - f.AcceptP2P = false - - id, err := api.NewFilter(f) - if err != nil { - t.Fatalf("failed to create new filter: %s.", err) - } - - var p PostArgs - p.TTL = 1 - p.KeyName = keyname - p.From = f.From - p.Padding = []byte("test string") - p.Payload = []byte("extended test string") - p.PoW = whisperv5.MinimumPoW - p.Topic = whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79} - p.WorkTime = 2 - - err = api.Post(p) - if err != nil { - t.Fatalf("failed to post first message: %s.", err) - } - - ok := waitForMessage(api, id, 1) - if !ok { - t.Fatalf("failed to receive first message: timeout.") - } - - mail := api.GetFilterChanges(id) - if len(mail) != 1 { - t.Fatalf("failed GetFilterChanges: got %d messages.", len(mail)) - } - - text := string(common.FromHex(mail[0].Payload)) - if text != string("extended test string") { - t.Fatalf("failed to decrypt first message: %s.", text) - } - - p.Padding = []byte("new value") - p.Payload = []byte("extended new value") - err = api.Post(p) - if err != nil { - t.Fatalf("failed to post second message: %s.", err) - } - - ok = waitForMessage(api, id, 2) - if !ok { - t.Fatalf("failed to receive second message: timeout.") - } - - mail = api.GetFilterChanges(id) - if len(mail) != 1 { - t.Fatalf("failed second GetFilterChanges: got %d messages.", len(mail)) - } - - text = string(common.FromHex(mail[0].Payload)) - if text != string("extended new value") { - t.Fatalf("failed to decrypt second message: %s.", text) - } -} - -func TestIntegrationSymWithFilter(t *testing.T) { - api := NewPublicWhisperAPI() - if api == nil { - t.Fatalf("failed to create API.") - } - - api.Start() - defer api.Stop() - - keyname := "schluessel" - err := api.GenerateSymKey(keyname) - if err != nil { - t.Fatalf("failed to GenerateSymKey: %s.", err) - } - - sig, err := api.NewIdentity() - if err != nil { - t.Fatalf("failed NewIdentity: %s.", err) - } - if len(sig) == 0 { - t.Fatalf("wrong signature.") - } - - exist, err := api.HasIdentity(sig) - if err != nil { - t.Fatalf("failed HasIdentity: %s.", err) - } - if !exist { - t.Fatalf("failed HasIdentity: does not exist.") - } - - var topics [2]whisperv5.TopicType - topics[0] = whisperv5.TopicType{0x00, 0x7f, 0x80, 0xff} - topics[1] = whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79} - var f WhisperFilterArgs - f.KeyName = keyname - f.Topics = topics[:] - f.PoW = 0.324 - f.From = sig - f.AcceptP2P = false - - id, err := api.NewFilter(f) - if err != nil { - t.Fatalf("failed to create new filter: %s.", err) - } - - var p PostArgs - p.TTL = 1 - p.FilterID = id - p.From = sig - p.Padding = []byte("test string") - p.Payload = []byte("extended test string") - p.PoW = whisperv5.MinimumPoW - p.Topic = whisperv5.TopicType{0xf2, 0x6e, 0x77, 0x79} - p.WorkTime = 2 - - err = api.Post(p) - if err != nil { - t.Fatalf("failed to post message: %s.", err) - } - - ok := waitForMessage(api, id, 1) - if !ok { - t.Fatalf("failed to receive first message: timeout.") - } - - mail := api.GetFilterChanges(id) - if len(mail) != 1 { - t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) - } - - text := string(common.FromHex(mail[0].Payload)) - if text != string("extended test string") { - t.Fatalf("failed to decrypt first message: %s.", text) - } - - p.Padding = []byte("new value") - p.Payload = []byte("extended new value") - err = api.Post(p) - if err != nil { - t.Fatalf("failed to post next message: %s.", err) - } - - ok = waitForMessage(api, id, 2) - if !ok { - t.Fatalf("failed to receive second message: timeout.") - } - - mail = api.GetFilterChanges(id) - if len(mail) != 1 { - t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) - } - - text = string(common.FromHex(mail[0].Payload)) - if text != string("extended new value") { - t.Fatalf("failed to decrypt second message: %s.", text) - } -} diff --git a/whisper/whisperv5/api.go b/whisper/whisperv5/api.go new file mode 100644 index 000000000..ce41624df --- /dev/null +++ b/whisper/whisperv5/api.go @@ -0,0 +1,463 @@ +// Copyright 2016 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 . + +package whisperv5 + +import ( + "encoding/json" + "errors" + "fmt" + mathrand "math/rand" + + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/common/hexutil" + "github.com/ethereum/go-ethereum/crypto" + "github.com/ethereum/go-ethereum/logger" + "github.com/ethereum/go-ethereum/logger/glog" +) + +var whisperOffLineErr = errors.New("whisper is offline") + +// PublicWhisperAPI provides the whisper RPC service. +type PublicWhisperAPI struct { + whisper *Whisper +} + +// NewPublicWhisperAPI create a new RPC whisper service. +func NewPublicWhisperAPI(w *Whisper) *PublicWhisperAPI { + return &PublicWhisperAPI{whisper: w} +} + +// Start starts the Whisper worker threads. +func (api *PublicWhisperAPI) Start() error { + if api.whisper == nil { + return whisperOffLineErr + } + return api.whisper.Start(nil) +} + +// Stop stops the Whisper worker threads. +func (api *PublicWhisperAPI) Stop() error { + if api.whisper == nil { + return whisperOffLineErr + } + return api.whisper.Stop() +} + +// Version returns the Whisper version this node offers. +func (api *PublicWhisperAPI) Version() (hexutil.Uint, error) { + if api.whisper == nil { + return 0, whisperOffLineErr + } + return hexutil.Uint(api.whisper.Version()), nil +} + +// MarkPeerTrusted marks specific peer trusted, which will allow it +// to send historic (expired) messages. +func (api *PublicWhisperAPI) MarkPeerTrusted(peerID hexutil.Bytes) error { + if api.whisper == nil { + return whisperOffLineErr + } + return api.whisper.MarkPeerTrusted(peerID) +} + +// RequestHistoricMessages requests the peer to deliver the old (expired) messages. +// data contains parameters (time frame, payment details, etc.), required +// by the remote email-like server. Whisper is not aware about the data format, +// it will just forward the raw data to the server. +//func (api *PublicWhisperAPI) RequestHistoricMessages(peerID hexutil.Bytes, data hexutil.Bytes) error { +// if api.whisper == nil { +// return whisperOffLineErr +// } +// return api.whisper.RequestHistoricMessages(peerID, data) +//} + +// HasIdentity checks if the whisper node is configured with the private key +// of the specified public pair. +func (api *PublicWhisperAPI) HasIdentity(identity string) (bool, error) { + if api.whisper == nil { + return false, whisperOffLineErr + } + return api.whisper.HasIdentity(identity), nil +} + +// DeleteIdentity deletes the specifies key if it exists. +func (api *PublicWhisperAPI) DeleteIdentity(identity string) error { + if api.whisper == nil { + return whisperOffLineErr + } + api.whisper.DeleteIdentity(identity) + return nil +} + +// NewIdentity generates a new cryptographic identity for the client, and injects +// it into the known identities for message decryption. +func (api *PublicWhisperAPI) NewIdentity() (string, error) { + if api.whisper == nil { + return "", whisperOffLineErr + } + identity := api.whisper.NewIdentity() + return common.ToHex(crypto.FromECDSAPub(&identity.PublicKey)), nil +} + +// GenerateSymKey generates a random symmetric key and stores it under +// the 'name' id. Will be used in the future for session key exchange. +func (api *PublicWhisperAPI) GenerateSymKey(name string) error { + if api.whisper == nil { + return whisperOffLineErr + } + return api.whisper.GenerateSymKey(name) +} + +// AddSymKey stores the key under the 'name' id. +func (api *PublicWhisperAPI) AddSymKey(name string, key []byte) error { + if api.whisper == nil { + return whisperOffLineErr + } + return api.whisper.AddSymKey(name, key) +} + +// HasSymKey returns true if there is a key associated with the name string. +// Otherwise returns false. +func (api *PublicWhisperAPI) HasSymKey(name string) (bool, error) { + if api.whisper == nil { + return false, whisperOffLineErr + } + res := api.whisper.HasSymKey(name) + return res, nil +} + +// DeleteSymKey deletes the key associated with the name string if it exists. +func (api *PublicWhisperAPI) DeleteSymKey(name string) error { + if api.whisper == nil { + return whisperOffLineErr + } + api.whisper.DeleteSymKey(name) + return nil +} + +// NewWhisperFilter creates and registers a new message filter to watch for inbound whisper messages. +// Returns the ID of the newly created Filter. +func (api *PublicWhisperAPI) NewFilter(args WhisperFilterArgs) (uint32, error) { + if api.whisper == nil { + return 0, whisperOffLineErr + } + + filter := Filter{ + Src: crypto.ToECDSAPub(common.FromHex(args.From)), + KeySym: api.whisper.GetSymKey(args.KeyName), + PoW: args.PoW, + Messages: make(map[common.Hash]*ReceivedMessage), + AcceptP2P: args.AcceptP2P, + } + if len(filter.KeySym) > 0 { + filter.SymKeyHash = crypto.Keccak256Hash(filter.KeySym) + } + filter.Topics = append(filter.Topics, args.Topics...) + + if len(args.Topics) == 0 { + info := "NewFilter: at least one topic must be specified" + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + + if len(args.KeyName) != 0 && len(filter.KeySym) == 0 { + info := "NewFilter: key was not found by name: " + args.KeyName + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + + if len(args.To) == 0 && len(filter.KeySym) == 0 { + info := "NewFilter: filter must contain either symmetric or asymmetric key" + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + + if len(args.To) != 0 && len(filter.KeySym) != 0 { + info := "NewFilter: filter must not contain both symmetric and asymmetric key" + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + + if len(args.To) > 0 { + dst := crypto.ToECDSAPub(common.FromHex(args.To)) + if !ValidatePublicKey(dst) { + info := "NewFilter: Invalid 'To' address" + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + filter.KeyAsym = api.whisper.GetIdentity(string(args.To)) + if filter.KeyAsym == nil { + info := "NewFilter: non-existent identity provided" + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + } + + if len(args.From) > 0 { + if !ValidatePublicKey(filter.Src) { + info := "NewFilter: Invalid 'From' address" + glog.V(logger.Error).Infof(info) + return 0, errors.New(info) + } + } + + id := api.whisper.Watch(&filter) + return id, nil +} + +// UninstallFilter disables and removes an existing filter. +func (api *PublicWhisperAPI) UninstallFilter(filterId uint32) { + api.whisper.Unwatch(filterId) +} + +// GetFilterChanges retrieves all the new messages matched by a filter since the last retrieval. +func (api *PublicWhisperAPI) GetFilterChanges(filterId uint32) []WhisperMessage { + f := api.whisper.GetFilter(filterId) + if f != nil { + newMail := f.Retrieve() + return toWhisperMessages(newMail) + } + return toWhisperMessages(nil) +} + +// GetMessages retrieves all the known messages that match a specific filter. +func (api *PublicWhisperAPI) GetMessages(filterId uint32) []WhisperMessage { + all := api.whisper.Messages(filterId) + return toWhisperMessages(all) +} + +// toWhisperMessages converts a Whisper message to a RPC whisper message. +func toWhisperMessages(messages []*ReceivedMessage) []WhisperMessage { + msgs := make([]WhisperMessage, len(messages)) + for i, msg := range messages { + msgs[i] = NewWhisperMessage(msg) + } + return msgs +} + +// Post creates a whisper message and injects it into the network for distribution. +func (api *PublicWhisperAPI) Post(args PostArgs) error { + if api.whisper == nil { + return whisperOffLineErr + } + + params := MessageParams{ + TTL: args.TTL, + Dst: crypto.ToECDSAPub(common.FromHex(args.To)), + KeySym: api.whisper.GetSymKey(args.KeyName), + Topic: args.Topic, + Payload: args.Payload, + Padding: args.Padding, + WorkTime: args.WorkTime, + PoW: args.PoW, + } + + if len(args.From) > 0 { + pub := crypto.ToECDSAPub(common.FromHex(args.From)) + if !ValidatePublicKey(pub) { + info := "Post: Invalid 'From' address" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + params.Src = api.whisper.GetIdentity(string(args.From)) + if params.Src == nil { + info := "Post: non-existent identity provided" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + } + + filter := api.whisper.GetFilter(args.FilterID) + if filter == nil && args.FilterID > 0 { + info := fmt.Sprintf("Post: wrong filter id %d", args.FilterID) + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + + if filter != nil { + // get the missing fields from the filter + if params.KeySym == nil && filter.KeySym != nil { + params.KeySym = filter.KeySym + } + if params.Src == nil && filter.Src != nil { + params.Src = filter.KeyAsym + } + if (params.Topic == TopicType{}) { + sz := len(filter.Topics) + if sz < 1 { + info := fmt.Sprintf("Post: no topics in filter # %d", args.FilterID) + glog.V(logger.Error).Infof(info) + return errors.New(info) + } else if sz == 1 { + params.Topic = filter.Topics[0] + } else { + // choose randomly + rnd := mathrand.Intn(sz) + params.Topic = filter.Topics[rnd] + } + } + } + + // validate + if len(args.KeyName) != 0 && len(params.KeySym) == 0 { + info := "Post: key was not found by name: " + args.KeyName + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + + if len(args.To) == 0 && len(params.KeySym) == 0 { + info := "Post: message must be encrypted either symmetrically or asymmetrically" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + + if len(args.To) != 0 && len(params.KeySym) != 0 { + info := "Post: ambigous encryption method requested" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + + if len(args.To) > 0 { + if !ValidatePublicKey(params.Dst) { + info := "Post: Invalid 'To' address" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + } + + // encrypt and send + message := NewSentMessage(¶ms) + envelope, err := message.Wrap(¶ms) + if err != nil { + glog.V(logger.Error).Infof(err.Error()) + return err + } + if len(envelope.Data) > MaxMessageLength { + info := "Post: message is too big" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + if (envelope.Topic == TopicType{} && envelope.IsSymmetric()) { + info := "Post: topic is missing for symmetric encryption" + glog.V(logger.Error).Infof(info) + return errors.New(info) + } + + if args.PeerID != nil { + return api.whisper.SendP2PMessage(args.PeerID, envelope) + } + + return api.whisper.Send(envelope) +} + +type PostArgs struct { + TTL uint32 `json:"ttl"` + From string `json:"from"` + To string `json:"to"` + KeyName string `json:"keyname"` + Topic TopicType `json:"topic"` + Padding hexutil.Bytes `json:"padding"` + Payload hexutil.Bytes `json:"payload"` + WorkTime uint32 `json:"worktime"` + PoW float64 `json:"pow"` + FilterID uint32 `json:"filterID"` + PeerID hexutil.Bytes `json:"peerID"` +} + +type WhisperFilterArgs struct { + To string + From string + KeyName string + PoW float64 + Topics []TopicType + AcceptP2P bool +} + +// UnmarshalJSON implements the json.Unmarshaler interface, invoked to convert a +// JSON message blob into a WhisperFilterArgs structure. +func (args *WhisperFilterArgs) UnmarshalJSON(b []byte) (err error) { + // Unmarshal the JSON message and sanity check + var obj struct { + To string `json:"to"` + From string `json:"from"` + KeyName string `json:"keyname"` + PoW float64 `json:"pow"` + Topics []interface{} `json:"topics"` + AcceptP2P bool `json:"acceptP2P"` + } + if err := json.Unmarshal(b, &obj); err != nil { + return err + } + + args.To = obj.To + args.From = obj.From + args.KeyName = obj.KeyName + args.PoW = obj.PoW + args.AcceptP2P = obj.AcceptP2P + + // Construct the topic array + if obj.Topics != nil { + topics := make([]string, len(obj.Topics)) + for i, field := range obj.Topics { + switch value := field.(type) { + case string: + topics[i] = value + case nil: + return fmt.Errorf("topic[%d] is empty", i) + default: + return fmt.Errorf("topic[%d] is not a string", i) + } + } + topicsDecoded := make([]TopicType, len(topics)) + for j, s := range topics { + x := common.FromHex(s) + if x == nil || len(x) != TopicLength { + return fmt.Errorf("topic[%d] is invalid", j) + } + topicsDecoded[j] = BytesToTopic(x) + } + args.Topics = topicsDecoded + } + + return nil +} + +// WhisperMessage is the RPC representation of a whisper message. +type WhisperMessage struct { + Payload string `json:"payload"` + Padding string `json:"padding"` + From string `json:"from"` + To string `json:"to"` + Sent uint32 `json:"sent"` + TTL uint32 `json:"ttl"` + PoW float64 `json:"pow"` + Hash string `json:"hash"` +} + +// NewWhisperMessage converts an internal message into an API version. +func NewWhisperMessage(message *ReceivedMessage) WhisperMessage { + return WhisperMessage{ + Payload: common.ToHex(message.Payload), + Padding: common.ToHex(message.Padding), + From: common.ToHex(crypto.FromECDSAPub(message.SigToPubKey())), + To: common.ToHex(crypto.FromECDSAPub(message.Dst)), + Sent: message.Sent, + TTL: message.TTL, + PoW: message.PoW, + Hash: common.ToHex(message.EnvelopeHash.Bytes()), + } +} diff --git a/whisper/whisperv5/api_test.go b/whisper/whisperv5/api_test.go new file mode 100644 index 000000000..f7deab39c --- /dev/null +++ b/whisper/whisperv5/api_test.go @@ -0,0 +1,573 @@ +// Copyright 2016 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 . + +package whisperv5 + +import ( + "bytes" + "encoding/json" + "testing" + "time" + + "github.com/ethereum/go-ethereum/common" +) + +func TestBasic(t *testing.T) { + var id string = "test" + w := New() + api := NewPublicWhisperAPI(w) + if api == nil { + t.Fatalf("failed to create API.") + } + + ver, err := api.Version() + if err != nil { + t.Fatalf("failed generateFilter: %s.", err) + } + + if uint64(ver) != ProtocolVersion { + t.Fatalf("wrong version: %d.", ver) + } + + mail := api.GetFilterChanges(1) + if len(mail) != 0 { + t.Fatalf("failed GetFilterChanges: premature result") + } + + exist, err := api.HasIdentity(id) + if err != nil { + t.Fatalf("failed initial HasIdentity: %s.", err) + } + if exist { + t.Fatalf("failed initial HasIdentity: false positive.") + } + + err = api.DeleteIdentity(id) + if err != nil { + t.Fatalf("failed DeleteIdentity: %s.", err) + } + + pub, err := api.NewIdentity() + if err != nil { + t.Fatalf("failed NewIdentity: %s.", err) + } + if len(pub) == 0 { + t.Fatalf("failed NewIdentity: empty") + } + + exist, err = api.HasIdentity(pub) + if err != nil { + t.Fatalf("failed HasIdentity: %s.", err) + } + if !exist { + t.Fatalf("failed HasIdentity: false negative.") + } + + err = api.DeleteIdentity(pub) + if err != nil { + t.Fatalf("failed to delete second identity: %s.", err) + } + + exist, err = api.HasIdentity(pub) + if err != nil { + t.Fatalf("failed HasIdentity(): %s.", err) + } + if exist { + t.Fatalf("failed HasIdentity(): false positive.") + } + + id = "arbitrary text" + id2 := "another arbitrary string" + + exist, err = api.HasSymKey(id) + if err != nil { + t.Fatalf("failed HasSymKey: %s.", err) + } + if exist { + t.Fatalf("failed HasSymKey: false positive.") + } + + err = api.GenerateSymKey(id) + if err != nil { + t.Fatalf("failed GenerateSymKey: %s.", err) + } + + exist, err = api.HasSymKey(id) + if err != nil { + t.Fatalf("failed HasSymKey(): %s.", err) + } + if !exist { + t.Fatalf("failed HasSymKey(): false negative.") + } + + err = api.AddSymKey(id, []byte("some stuff here")) + if err == nil { + t.Fatalf("failed AddSymKey: %s.", err) + } + + err = api.AddSymKey(id2, []byte("some stuff here")) + if err != nil { + t.Fatalf("failed AddSymKey: %s.", err) + } + + exist, err = api.HasSymKey(id2) + if err != nil { + t.Fatalf("failed HasSymKey(id2): %s.", err) + } + if !exist { + t.Fatalf("failed HasSymKey(id2): false negative.") + } + + err = api.DeleteSymKey(id) + if err != nil { + t.Fatalf("failed DeleteSymKey(id): %s.", err) + } + + exist, err = api.HasSymKey(id) + if err != nil { + t.Fatalf("failed HasSymKey(id): %s.", err) + } + if exist { + t.Fatalf("failed HasSymKey(id): false positive.") + } +} + +func TestUnmarshalFilterArgs(t *testing.T) { + s := []byte(`{ + "to":"0x70c87d191324e6712a591f304b4eedef6ad9bb9d", + "from":"0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", + "keyname":"testname", + "pow":2.34, + "topics":["0x00000000", "0x007f80ff", "0xff807f00", "0xf26e7779"], + "acceptP2P":true + }`) + + var f WhisperFilterArgs + err := f.UnmarshalJSON(s) + if err != nil { + t.Fatalf("failed UnmarshalJSON: %s.", err) + } + + if f.To != "0x70c87d191324e6712a591f304b4eedef6ad9bb9d" { + t.Fatalf("wrong To: %x.", f.To) + } + if f.From != "0x9b2055d370f73ec7d8a03e965129118dc8f5bf83" { + t.Fatalf("wrong From: %x.", f.To) + } + if f.KeyName != "testname" { + t.Fatalf("wrong KeyName: %s.", f.KeyName) + } + if f.PoW != 2.34 { + t.Fatalf("wrong pow: %f.", f.PoW) + } + if !f.AcceptP2P { + t.Fatalf("wrong AcceptP2P: %v.", f.AcceptP2P) + } + if len(f.Topics) != 4 { + t.Fatalf("wrong topics number: %d.", len(f.Topics)) + } + + i := 0 + if f.Topics[i] != (TopicType{0x00, 0x00, 0x00, 0x00}) { + t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) + } + + i++ + if f.Topics[i] != (TopicType{0x00, 0x7f, 0x80, 0xff}) { + t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) + } + + i++ + if f.Topics[i] != (TopicType{0xff, 0x80, 0x7f, 0x00}) { + t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) + } + + i++ + if f.Topics[i] != (TopicType{0xf2, 0x6e, 0x77, 0x79}) { + t.Fatalf("wrong topic[%d]: %x.", i, f.Topics[i]) + } +} + +func TestUnmarshalPostArgs(t *testing.T) { + s := []byte(`{ + "ttl":12345, + "from":"0x70c87d191324e6712a591f304b4eedef6ad9bb9d", + "to":"0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", + "keyname":"shh_test", + "topic":"0xf26e7779", + "padding":"0x74686973206973206D79207465737420737472696E67", + "payload":"0x7061796C6F61642073686F756C642062652070736575646F72616E646F6D", + "worktime":777, + "pow":3.1416, + "filterID":64, + "peerID":"0xf26e7779" + }`) + + var a PostArgs + err := json.Unmarshal(s, &a) + if err != nil { + t.Fatalf("failed UnmarshalJSON: %s.", err) + } + + if a.TTL != 12345 { + t.Fatalf("wrong ttl: %d.", a.TTL) + } + if a.From != "0x70c87d191324e6712a591f304b4eedef6ad9bb9d" { + t.Fatalf("wrong From: %x.", a.To) + } + if a.To != "0x9b2055d370f73ec7d8a03e965129118dc8f5bf83" { + t.Fatalf("wrong To: %x.", a.To) + } + if a.KeyName != "shh_test" { + t.Fatalf("wrong KeyName: %s.", a.KeyName) + } + if a.Topic != (TopicType{0xf2, 0x6e, 0x77, 0x79}) { + t.Fatalf("wrong topic: %x.", a.Topic) + } + if string(a.Padding) != "this is my test string" { + t.Fatalf("wrong Padding: %s.", string(a.Padding)) + } + if string(a.Payload) != "payload should be pseudorandom" { + t.Fatalf("wrong Payload: %s.", string(a.Payload)) + } + if a.WorkTime != 777 { + t.Fatalf("wrong WorkTime: %d.", a.WorkTime) + } + if a.PoW != 3.1416 { + t.Fatalf("wrong pow: %f.", a.PoW) + } + if a.FilterID != 64 { + t.Fatalf("wrong FilterID: %d.", a.FilterID) + } + if !bytes.Equal(a.PeerID[:], a.Topic[:]) { + t.Fatalf("wrong PeerID: %x.", a.PeerID) + } +} + +func waitForMessage(api *PublicWhisperAPI, id uint32, target int) bool { + for i := 0; i < 64; i++ { + all := api.GetMessages(id) + if len(all) >= target { + return true + } + time.Sleep(time.Millisecond * 16) + } + + // timeout 1024 milliseconds + return false +} + +func TestIntegrationAsym(t *testing.T) { + w := New() + api := NewPublicWhisperAPI(w) + if api == nil { + t.Fatalf("failed to create API.") + } + + api.Start() + defer api.Stop() + + sig, err := api.NewIdentity() + if err != nil { + t.Fatalf("failed NewIdentity: %s.", err) + } + if len(sig) == 0 { + t.Fatalf("wrong signature") + } + + exist, err := api.HasIdentity(sig) + if err != nil { + t.Fatalf("failed HasIdentity: %s.", err) + } + if !exist { + t.Fatalf("failed HasIdentity: false negative.") + } + + key, err := api.NewIdentity() + if err != nil { + t.Fatalf("failed NewIdentity(): %s.", err) + } + if len(key) == 0 { + t.Fatalf("wrong key") + } + + var topics [2]TopicType + topics[0] = TopicType{0x00, 0x64, 0x00, 0xff} + topics[1] = TopicType{0xf2, 0x6e, 0x77, 0x79} + var f WhisperFilterArgs + f.To = key + f.From = sig + f.Topics = topics[:] + f.PoW = MinimumPoW / 2 + f.AcceptP2P = true + + id, err := api.NewFilter(f) + if err != nil { + t.Fatalf("failed to create new filter: %s.", err) + } + + var p PostArgs + p.TTL = 2 + p.From = f.From + p.To = f.To + p.Padding = []byte("test string") + p.Payload = []byte("extended test string") + p.PoW = MinimumPoW + p.Topic = TopicType{0xf2, 0x6e, 0x77, 0x79} + p.WorkTime = 2 + + err = api.Post(p) + if err != nil { + t.Errorf("failed to post message: %s.", err) + } + + ok := waitForMessage(api, id, 1) + if !ok { + t.Fatalf("failed to receive first message: timeout.") + } + + mail := api.GetFilterChanges(id) + if len(mail) != 1 { + t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) + } + + text := string(common.FromHex(mail[0].Payload)) + if text != string("extended test string") { + t.Fatalf("failed to decrypt first message: %s.", text) + } + + p.Padding = []byte("new value") + p.Payload = []byte("extended new value") + err = api.Post(p) + if err != nil { + t.Fatalf("failed to post next message: %s.", err) + } + + ok = waitForMessage(api, id, 2) + if !ok { + t.Fatalf("failed to receive second message: timeout.") + } + + mail = api.GetFilterChanges(id) + if len(mail) != 1 { + t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) + } + + text = string(common.FromHex(mail[0].Payload)) + if text != string("extended new value") { + t.Fatalf("failed to decrypt second message: %s.", text) + } +} + +func TestIntegrationSym(t *testing.T) { + w := New() + api := NewPublicWhisperAPI(w) + if api == nil { + t.Fatalf("failed to create API.") + } + + api.Start() + defer api.Stop() + + keyname := "schluessel" + err := api.GenerateSymKey(keyname) + if err != nil { + t.Fatalf("failed GenerateSymKey: %s.", err) + } + + sig, err := api.NewIdentity() + if err != nil { + t.Fatalf("failed NewIdentity: %s.", err) + } + if len(sig) == 0 { + t.Fatalf("wrong signature") + } + + exist, err := api.HasIdentity(sig) + if err != nil { + t.Fatalf("failed HasIdentity: %s.", err) + } + if !exist { + t.Fatalf("failed HasIdentity: false negative.") + } + + var topics [2]TopicType + topics[0] = TopicType{0x00, 0x7f, 0x80, 0xff} + topics[1] = TopicType{0xf2, 0x6e, 0x77, 0x79} + var f WhisperFilterArgs + f.KeyName = keyname + f.Topics = topics[:] + f.PoW = 0.324 + f.From = sig + f.AcceptP2P = false + + id, err := api.NewFilter(f) + if err != nil { + t.Fatalf("failed to create new filter: %s.", err) + } + + var p PostArgs + p.TTL = 1 + p.KeyName = keyname + p.From = f.From + p.Padding = []byte("test string") + p.Payload = []byte("extended test string") + p.PoW = MinimumPoW + p.Topic = TopicType{0xf2, 0x6e, 0x77, 0x79} + p.WorkTime = 2 + + err = api.Post(p) + if err != nil { + t.Fatalf("failed to post first message: %s.", err) + } + + ok := waitForMessage(api, id, 1) + if !ok { + t.Fatalf("failed to receive first message: timeout.") + } + + mail := api.GetFilterChanges(id) + if len(mail) != 1 { + t.Fatalf("failed GetFilterChanges: got %d messages.", len(mail)) + } + + text := string(common.FromHex(mail[0].Payload)) + if text != string("extended test string") { + t.Fatalf("failed to decrypt first message: %s.", text) + } + + p.Padding = []byte("new value") + p.Payload = []byte("extended new value") + err = api.Post(p) + if err != nil { + t.Fatalf("failed to post second message: %s.", err) + } + + ok = waitForMessage(api, id, 2) + if !ok { + t.Fatalf("failed to receive second message: timeout.") + } + + mail = api.GetFilterChanges(id) + if len(mail) != 1 { + t.Fatalf("failed second GetFilterChanges: got %d messages.", len(mail)) + } + + text = string(common.FromHex(mail[0].Payload)) + if text != string("extended new value") { + t.Fatalf("failed to decrypt second message: %s.", text) + } +} + +func TestIntegrationSymWithFilter(t *testing.T) { + w := New() + api := NewPublicWhisperAPI(w) + if api == nil { + t.Fatalf("failed to create API.") + } + + api.Start() + defer api.Stop() + + keyname := "schluessel" + err := api.GenerateSymKey(keyname) + if err != nil { + t.Fatalf("failed to GenerateSymKey: %s.", err) + } + + sig, err := api.NewIdentity() + if err != nil { + t.Fatalf("failed NewIdentity: %s.", err) + } + if len(sig) == 0 { + t.Fatalf("wrong signature.") + } + + exist, err := api.HasIdentity(sig) + if err != nil { + t.Fatalf("failed HasIdentity: %s.", err) + } + if !exist { + t.Fatalf("failed HasIdentity: does not exist.") + } + + var topics [2]TopicType + topics[0] = TopicType{0x00, 0x7f, 0x80, 0xff} + topics[1] = TopicType{0xf2, 0x6e, 0x77, 0x79} + var f WhisperFilterArgs + f.KeyName = keyname + f.Topics = topics[:] + f.PoW = 0.324 + f.From = sig + f.AcceptP2P = false + + id, err := api.NewFilter(f) + if err != nil { + t.Fatalf("failed to create new filter: %s.", err) + } + + var p PostArgs + p.TTL = 1 + p.FilterID = id + p.From = sig + p.Padding = []byte("test string") + p.Payload = []byte("extended test string") + p.PoW = MinimumPoW + p.Topic = TopicType{0xf2, 0x6e, 0x77, 0x79} + p.WorkTime = 2 + + err = api.Post(p) + if err != nil { + t.Fatalf("failed to post message: %s.", err) + } + + ok := waitForMessage(api, id, 1) + if !ok { + t.Fatalf("failed to receive first message: timeout.") + } + + mail := api.GetFilterChanges(id) + if len(mail) != 1 { + t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) + } + + text := string(common.FromHex(mail[0].Payload)) + if text != string("extended test string") { + t.Fatalf("failed to decrypt first message: %s.", text) + } + + p.Padding = []byte("new value") + p.Payload = []byte("extended new value") + err = api.Post(p) + if err != nil { + t.Fatalf("failed to post next message: %s.", err) + } + + ok = waitForMessage(api, id, 2) + if !ok { + t.Fatalf("failed to receive second message: timeout.") + } + + mail = api.GetFilterChanges(id) + if len(mail) != 1 { + t.Fatalf("failed to GetFilterChanges: got %d messages.", len(mail)) + } + + text = string(common.FromHex(mail[0].Payload)) + if text != string("extended new value") { + t.Fatalf("failed to decrypt second message: %s.", text) + } +} diff --git a/whisper/whisperv5/filter_test.go b/whisper/whisperv5/filter_test.go index 9f2a58f28..5bf607ccc 100644 --- a/whisper/whisperv5/filter_test.go +++ b/whisper/whisperv5/filter_test.go @@ -96,7 +96,7 @@ func TestInstallFilters(t *testing.T) { InitSingleTest() const SizeTestFilters = 256 - w := NewWhisper(nil) + w := New() filters := NewFilters(w) tst := generateTestCases(t, SizeTestFilters) @@ -520,7 +520,7 @@ func TestWatchers(t *testing.T) { var j uint32 var e *Envelope - w := NewWhisper(nil) + w := New() filters := NewFilters(w) tst := generateTestCases(t, NumFilters) for i = 0; i < NumFilters; i++ { diff --git a/whisper/whisperv5/peer_test.go b/whisper/whisperv5/peer_test.go index 34e2ec255..cc98ba2d6 100644 --- a/whisper/whisperv5/peer_test.go +++ b/whisper/whisperv5/peer_test.go @@ -116,7 +116,7 @@ func initialize(t *testing.T) { for i := 0; i < NumNodes; i++ { var node TestNode - node.shh = NewWhisper(nil) + node.shh = New() node.shh.test = true node.shh.Start(nil) topics := make([]TopicType, 0) diff --git a/whisper/whisperv5/whisper.go b/whisper/whisperv5/whisper.go index ff31aab2d..a027fd84b 100644 --- a/whisper/whisperv5/whisper.go +++ b/whisper/whisperv5/whisper.go @@ -31,6 +31,7 @@ import ( "github.com/ethereum/go-ethereum/logger" "github.com/ethereum/go-ethereum/logger/glog" "github.com/ethereum/go-ethereum/p2p" + "github.com/ethereum/go-ethereum/rpc" "golang.org/x/crypto/pbkdf2" set "gopkg.in/fatih/set.v0" ) @@ -65,7 +66,7 @@ type Whisper struct { // New creates a Whisper client ready to communicate through the Ethereum P2P network. // Param s should be passed if you want to implement mail server, otherwise nil. -func NewWhisper(server MailServer) *Whisper { +func New() *Whisper { whisper := &Whisper{ privateKeys: make(map[string]*ecdsa.PrivateKey), symKeys: make(map[string][]byte), @@ -73,7 +74,6 @@ func NewWhisper(server MailServer) *Whisper { messages: make(map[common.Hash]*ReceivedMessage), expirations: make(map[uint32]*set.SetNonTS), peers: make(map[*Peer]struct{}), - mailServer: server, messageQueue: make(chan *Envelope, messageQueueLimit), p2pMsgQueue: make(chan *Envelope, messageQueueLimit), quit: make(chan struct{}), @@ -91,6 +91,22 @@ func NewWhisper(server MailServer) *Whisper { return whisper } +// APIs returns the RPC descriptors the Whisper implementation offers +func (w *Whisper) APIs() []rpc.API { + return []rpc.API{ + { + Namespace: ProtocolName, + Version: ProtocolVersionStr, + Service: NewPublicWhisperAPI(w), + Public: true, + }, + } +} + +func (w *Whisper) RegisterServer(server MailServer) { + w.mailServer = server +} + // Protocols returns the whisper sub-protocols ran by this particular client. func (w *Whisper) Protocols() []p2p.Protocol { return []p2p.Protocol{w.protocol} diff --git a/whisper/whisperv5/whisper_test.go b/whisper/whisperv5/whisper_test.go index a3ded7b37..c2ae35a3e 100644 --- a/whisper/whisperv5/whisper_test.go +++ b/whisper/whisperv5/whisper_test.go @@ -26,7 +26,7 @@ import ( ) func TestWhisperBasic(t *testing.T) { - w := NewWhisper(nil) + w := New() p := w.Protocols() shh := p[0] if shh.Name != ProtocolName { @@ -110,7 +110,7 @@ func TestWhisperBasic(t *testing.T) { } func TestWhisperIdentityManagement(t *testing.T) { - w := NewWhisper(nil) + w := New() id1 := w.NewIdentity() id2 := w.NewIdentity() pub1 := common.ToHex(crypto.FromECDSAPub(&id1.PublicKey)) @@ -186,7 +186,7 @@ func TestWhisperSymKeyManagement(t *testing.T) { InitSingleTest() var k1, k2 []byte - w := NewWhisper(nil) + w := New() id1 := string("arbitrary-string-1") id2 := string("arbitrary-string-2") @@ -304,7 +304,7 @@ func TestWhisperSymKeyManagement(t *testing.T) { func TestExpiry(t *testing.T) { InitSingleTest() - w := NewWhisper(nil) + w := New() w.test = true w.Start(nil) defer w.Stop() -- cgit