whisper/shhapi, whisper/whisperv5: refactoring (#3364)

* Filter refactoring
* API tests added + bugfix
* fixed the error logs
* FilterID fixed
* test cases fixed
* key generation updated
* POW updated
* got rid of redundant stuff

whisper/shhapi/api.go

@@ -149,13 +149,13 @@ func (api *PublicWhisperAPI) DeleteSymKey(name string) error {
 
 // 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) (*rpc.HexNumber, error) {
+func (api *PublicWhisperAPI) NewFilter(args WhisperFilterArgs) (uint32, error) {
 	if api.whisper == nil {
-		return nil, whisperOffLineErr
+		return 0, whisperOffLineErr
 	}
 
 	filter := whisperv5.Filter{
-		Src:       crypto.ToECDSAPub(args.From),
+		Src:       crypto.ToECDSAPub(common.FromHex(args.From)),
 		KeySym:    api.whisper.GetSymKey(args.KeyName),
 		PoW:       args.PoW,
 		Messages:  make(map[common.Hash]*whisperv5.ReceivedMessage),
@@ -173,39 +173,39 @@ func (api *PublicWhisperAPI) NewFilter(args WhisperFilterArgs) (*rpc.HexNumber,
 	if len(args.Topics) == 0 {
 		info := "NewFilter: at least one topic must be specified"
 		glog.V(logger.Error).Infof(info)
-		return nil, errors.New(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 nil, errors.New(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 nil, errors.New(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 nil, errors.New(info)
+		return 0, errors.New(info)
 	}
 
 	if len(args.To) > 0 {
-		dst := crypto.ToECDSAPub(args.To)
+		dst := crypto.ToECDSAPub(common.FromHex(args.To))
 		if !whisperv5.ValidatePublicKey(dst) {
 			info := "NewFilter: Invalid 'To' address"
 			glog.V(logger.Error).Infof(info)
-			return nil, errors.New(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 nil, errors.New(info)
+			return 0, errors.New(info)
 		}
 	}
 
@@ -213,22 +213,22 @@ func (api *PublicWhisperAPI) NewFilter(args WhisperFilterArgs) (*rpc.HexNumber,
 		if !whisperv5.ValidatePublicKey(filter.Src) {
 			info := "NewFilter: Invalid 'From' address"
 			glog.V(logger.Error).Infof(info)
-			return nil, errors.New(info)
+			return 0, errors.New(info)
 		}
 	}
 
 	id := api.whisper.Watch(&filter)
-	return rpc.NewHexNumber(id), nil
+	return id, nil
 }
 
 // UninstallFilter disables and removes an existing filter.
-func (api *PublicWhisperAPI) UninstallFilter(filterId rpc.HexNumber) {
-	api.whisper.Unwatch(filterId.Int())
+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 rpc.HexNumber) []WhisperMessage {
-	f := api.whisper.GetFilter(filterId.Int())
+func (api *PublicWhisperAPI) GetFilterChanges(filterId uint32) []WhisperMessage {
+	f := api.whisper.GetFilter(filterId)
 	if f != nil {
 		newMail := f.Retrieve()
 		return toWhisperMessages(newMail)
@@ -237,8 +237,8 @@ func (api *PublicWhisperAPI) GetFilterChanges(filterId rpc.HexNumber) []WhisperM
 }
 
 // GetMessages retrieves all the known messages that match a specific filter.
-func (api *PublicWhisperAPI) GetMessages(filterId rpc.HexNumber) []WhisperMessage {
-	all := api.whisper.Messages(filterId.Int())
+func (api *PublicWhisperAPI) GetMessages(filterId uint32) []WhisperMessage {
+	all := api.whisper.Messages(filterId)
 	return toWhisperMessages(all)
 }
 
@@ -259,7 +259,7 @@ func (api *PublicWhisperAPI) Post(args PostArgs) error {
 
 	params := whisperv5.MessageParams{
 		TTL:      args.TTL,
-		Dst:      crypto.ToECDSAPub(args.To),
+		Dst:      crypto.ToECDSAPub(common.FromHex(args.To)),
 		KeySym:   api.whisper.GetSymKey(args.KeyName),
 		Topic:    args.Topic,
 		Payload:  args.Payload,
@@ -269,7 +269,7 @@ func (api *PublicWhisperAPI) Post(args PostArgs) error {
 	}
 
 	if len(args.From) > 0 {
-		pub := crypto.ToECDSAPub(args.From)
+		pub := crypto.ToECDSAPub(common.FromHex(args.From))
 		if !whisperv5.ValidatePublicKey(pub) {
 			info := "Post: Invalid 'From' address"
 			glog.V(logger.Error).Infof(info)
@@ -284,7 +284,7 @@ func (api *PublicWhisperAPI) Post(args PostArgs) error {
 	}
 
 	filter := api.whisper.GetFilter(args.FilterID)
-	if filter == nil && args.FilterID > -1 {
+	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)
@@ -321,13 +321,13 @@ func (api *PublicWhisperAPI) Post(args PostArgs) error {
 		return errors.New(info)
 	}
 
-	if len(args.To) == 0 && len(args.KeyName) == 0 {
+	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(args.KeyName) != 0 {
+	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)
@@ -368,60 +368,21 @@ func (api *PublicWhisperAPI) Post(args PostArgs) error {
 
 type PostArgs struct {
 	TTL      uint32              `json:"ttl"`
-	From     rpc.HexBytes        `json:"from"`
-	To       rpc.HexBytes        `json:"to"`
+	From     string              `json:"from"`
+	To       string              `json:"to"`
 	KeyName  string              `json:"keyname"`
 	Topic    whisperv5.TopicType `json:"topic"`
 	Padding  rpc.HexBytes        `json:"padding"`
 	Payload  rpc.HexBytes        `json:"payload"`
 	WorkTime uint32              `json:"worktime"`
 	PoW      float64             `json:"pow"`
-	FilterID int                 `json:"filter"`
-	PeerID   rpc.HexBytes        `json:"directP2P"`
-}
-
-func (args *PostArgs) UnmarshalJSON(data []byte) (err error) {
-	var obj struct {
-		TTL      uint32              `json:"ttl"`
-		From     rpc.HexBytes        `json:"from"`
-		To       rpc.HexBytes        `json:"to"`
-		KeyName  string              `json:"keyname"`
-		Topic    whisperv5.TopicType `json:"topic"`
-		Payload  rpc.HexBytes        `json:"payload"`
-		Padding  rpc.HexBytes        `json:"padding"`
-		WorkTime uint32              `json:"worktime"`
-		PoW      float64             `json:"pow"`
-		FilterID rpc.HexBytes        `json:"filter"`
-		PeerID   rpc.HexBytes        `json:"directP2P"`
-	}
-
-	if err := json.Unmarshal(data, &obj); err != nil {
-		return err
-	}
-
-	args.TTL = obj.TTL
-	args.From = obj.From
-	args.To = obj.To
-	args.KeyName = obj.KeyName
-	args.Topic = obj.Topic
-	args.Payload = obj.Payload
-	args.Padding = obj.Padding
-	args.WorkTime = obj.WorkTime
-	args.PoW = obj.PoW
-	args.FilterID = -1
-	args.PeerID = obj.PeerID
-
-	if obj.FilterID != nil {
-		x := whisperv5.BytesToIntBigEndian(obj.FilterID)
-		args.FilterID = int(x)
-	}
-
-	return nil
+	FilterID uint32              `json:"filterID"`
+	PeerID   rpc.HexBytes        `json:"peerID"`
 }
 
 type WhisperFilterArgs struct {
-	To        []byte
-	From      []byte
+	To        string
+	From      string
 	KeyName   string
 	PoW       float64
 	Topics    []whisperv5.TopicType
@@ -433,8 +394,8 @@ type WhisperFilterArgs struct {
 func (args *WhisperFilterArgs) UnmarshalJSON(b []byte) (err error) {
 	// Unmarshal the JSON message and sanity check
 	var obj struct {
-		To        rpc.HexBytes  `json:"to"`
-		From      rpc.HexBytes  `json:"from"`
+		To        string        `json:"to"`
+		From      string        `json:"from"`
 		KeyName   string        `json:"keyname"`
 		PoW       float64       `json:"pow"`
 		Topics    []interface{} `json:"topics"`

whisper/whisperv5/benchmarks_test.go

@@ -40,8 +40,7 @@ func BenchmarkEncryptionSym(b *testing.B) {
 
 	params, err := generateMessageParams()
 	if err != nil {
-		b.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 
 	for i := 0; i < b.N; i++ {
@@ -60,13 +59,11 @@ func BenchmarkEncryptionAsym(b *testing.B) {
 
 	params, err := generateMessageParams()
 	if err != nil {
-		b.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 	key, err := crypto.GenerateKey()
 	if err != nil {
-		b.Errorf("failed GenerateKey with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err)
 	}
 	params.KeySym = nil
 	params.Dst = &key.PublicKey
@@ -75,8 +72,7 @@ func BenchmarkEncryptionAsym(b *testing.B) {
 		msg := NewSentMessage(params)
 		_, err := msg.Wrap(params)
 		if err != nil {
-			b.Errorf("failed Wrap with seed %d: %s.", seed, err)
-			return
+			b.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 		}
 	}
 }
@@ -86,22 +82,19 @@ func BenchmarkDecryptionSymValid(b *testing.B) {
 
 	params, err := generateMessageParams()
 	if err != nil {
-		b.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		b.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 	f := Filter{KeySym: params.KeySym}
 
 	for i := 0; i < b.N; i++ {
 		msg := env.Open(&f)
 		if msg == nil {
-			b.Errorf("failed to open with seed %d.", seed)
-			return
+			b.Fatalf("failed to open with seed %d.", seed)
 		}
 	}
 }
@@ -111,22 +104,19 @@ func BenchmarkDecryptionSymInvalid(b *testing.B) {
 
 	params, err := generateMessageParams()
 	if err != nil {
-		b.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		b.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 	f := Filter{KeySym: []byte("arbitrary stuff here")}
 
 	for i := 0; i < b.N; i++ {
 		msg := env.Open(&f)
 		if msg != nil {
-			b.Errorf("opened envelope with invalid key, seed: %d.", seed)
-			return
+			b.Fatalf("opened envelope with invalid key, seed: %d.", seed)
 		}
 	}
 }
@@ -136,13 +126,11 @@ func BenchmarkDecryptionAsymValid(b *testing.B) {
 
 	params, err := generateMessageParams()
 	if err != nil {
-		b.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 	key, err := crypto.GenerateKey()
 	if err != nil {
-		b.Errorf("failed GenerateKey with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err)
 	}
 	f := Filter{KeyAsym: key}
 	params.KeySym = nil
@@ -150,15 +138,13 @@ func BenchmarkDecryptionAsymValid(b *testing.B) {
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		b.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 
 	for i := 0; i < b.N; i++ {
 		msg := env.Open(&f)
 		if msg == nil {
-			b.Errorf("fail to open, seed: %d.", seed)
-			return
+			b.Fatalf("fail to open, seed: %d.", seed)
 		}
 	}
 }
@@ -168,35 +154,30 @@ func BenchmarkDecryptionAsymInvalid(b *testing.B) {
 
 	params, err := generateMessageParams()
 	if err != nil {
-		b.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 	key, err := crypto.GenerateKey()
 	if err != nil {
-		b.Errorf("failed GenerateKey with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err)
 	}
 	params.KeySym = nil
 	params.Dst = &key.PublicKey
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		b.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 
 	key, err = crypto.GenerateKey()
 	if err != nil {
-		b.Errorf("failed GenerateKey with seed %d: %s.", seed, err)
-		return
+		b.Fatalf("failed GenerateKey with seed %d: %s.", seed, err)
 	}
 	f := Filter{KeyAsym: key}
 
 	for i := 0; i < b.N; i++ {
 		msg := env.Open(&f)
 		if msg != nil {
-			b.Errorf("opened envelope with invalid key, seed: %d.", seed)
-			return
+			b.Fatalf("opened envelope with invalid key, seed: %d.", seed)
 		}
 	}
 }

whisper/whisperv5/doc.go

@@ -46,15 +46,16 @@ const (
 	messagesCode         = 1
 	p2pCode              = 2
 	mailRequestCode      = 3
-	NumberOfMessageCodes = 4
+	NumberOfMessageCodes = 32
 
 	paddingMask   = byte(3)
 	signatureFlag = byte(4)
 
-	TopicLength     = 4
-	signatureLength = 65
-	aesKeyLength    = 32
-	saltLength      = 12
+	TopicLength       = 4
+	signatureLength   = 65
+	aesKeyLength      = 32
+	saltLength        = 12
+	AESNonceMaxLength = 12
 
 	MaxMessageLength = 0xFFFF // todo: remove this restriction after testing in morden and analizing stats. this should be regulated by MinimumPoW.
 	MinimumPoW       = 10.0   // todo: review

whisper/whisperv5/envelope.go

@@ -73,7 +73,7 @@ func NewEnvelope(ttl uint32, topic TopicType, salt []byte, aesNonce []byte, msg
 }
 
 func (e *Envelope) IsSymmetric() bool {
-	return e.AESNonce != nil
+	return len(e.AESNonce) > 0
 }
 
 func (e *Envelope) isAsymmetric() bool {
@@ -131,7 +131,7 @@ func (e *Envelope) calculatePoW(diff uint32) {
 	h = crypto.Keccak256(buf)
 	firstBit := common.FirstBitSet(common.BigD(h))
 	x := math.Pow(2, float64(firstBit))
-	x /= float64(len(e.Data))
+	x /= float64(len(e.Data)) // we only count e.Data, other variable-sized members are checked in Whisper.add()
 	x /= float64(e.TTL + diff)
 	e.pow = x
 }

whisper/whisperv5/filter.go

@@ -37,20 +37,20 @@ type Filter struct {
 }
 
 type Filters struct {
-	id       int
-	watchers map[int]*Filter
+	id       uint32 // can contain any value except zero
+	watchers map[uint32]*Filter
 	whisper  *Whisper
 	mutex    sync.RWMutex
 }
 
 func NewFilters(w *Whisper) *Filters {
 	return &Filters{
-		watchers: make(map[int]*Filter),
+		watchers: make(map[uint32]*Filter),
 		whisper:  w,
 	}
 }
 
-func (fs *Filters) Install(watcher *Filter) int {
+func (fs *Filters) Install(watcher *Filter) uint32 {
 	if watcher.Messages == nil {
 		watcher.Messages = make(map[common.Hash]*ReceivedMessage)
 	}
@@ -58,19 +58,18 @@ func (fs *Filters) Install(watcher *Filter) int {
 	fs.mutex.Lock()
 	defer fs.mutex.Unlock()
 
-	fs.watchers[fs.id] = watcher
-	ret := fs.id
 	fs.id++
-	return ret
+	fs.watchers[fs.id] = watcher
+	return fs.id
 }
 
-func (fs *Filters) Uninstall(id int) {
+func (fs *Filters) Uninstall(id uint32) {
 	fs.mutex.Lock()
 	defer fs.mutex.Unlock()
 	delete(fs.watchers, id)
 }
 
-func (fs *Filters) Get(i int) *Filter {
+func (fs *Filters) Get(i uint32) *Filter {
 	fs.mutex.RLock()
 	defer fs.mutex.RUnlock()
 	return fs.watchers[i]
@@ -143,18 +142,9 @@ func (f *Filter) MatchMessage(msg *ReceivedMessage) bool {
 	}
 
 	if f.expectsAsymmetricEncryption() && msg.isAsymmetricEncryption() {
-		// if Dst match, ignore the topic
-		return isPubKeyEqual(&f.KeyAsym.PublicKey, msg.Dst)
+		return isPubKeyEqual(&f.KeyAsym.PublicKey, msg.Dst) && f.MatchTopic(msg.Topic)
 	} else if f.expectsSymmetricEncryption() && msg.isSymmetricEncryption() {
-		// check if that both the key and the topic match
-		if f.SymKeyHash == msg.SymKeyHash {
-			for _, t := range f.Topics {
-				if t == msg.Topic {
-					return true
-				}
-			}
-			return false
-		}
+		return f.SymKeyHash == msg.SymKeyHash && f.MatchTopic(msg.Topic)
 	}
 	return false
 }
@@ -164,25 +154,25 @@ func (f *Filter) MatchEnvelope(envelope *Envelope) bool {
 		return false
 	}
 
-	encryptionMethodMatch := false
 	if f.expectsAsymmetricEncryption() && envelope.isAsymmetric() {
-		encryptionMethodMatch = true
-		if f.Topics == nil {
-			// wildcard
-			return true
-		}
+		return f.MatchTopic(envelope.Topic)
 	} else if f.expectsSymmetricEncryption() && envelope.IsSymmetric() {
-		encryptionMethodMatch = true
+		return f.MatchTopic(envelope.Topic)
 	}
+	return false
+}
 
-	if encryptionMethodMatch {
-		for _, t := range f.Topics {
-			if t == envelope.Topic {
-				return true
-			}
-		}
+func (f *Filter) MatchTopic(topic TopicType) bool {
+	if len(f.Topics) == 0 {
+		// any topic matches
+		return true
 	}
 
+	for _, t := range f.Topics {
+		if t == topic {
+			return true
+		}
+	}
 	return false
 }
 

whisper/whisperv5/message.go

@@ -130,7 +130,7 @@ func (msg *SentMessage) appendPadding(params *MessageParams) {
 			panic("please fix the padding algorithm before releasing new version")
 		}
 		buf := make([]byte, padSize)
-		randomize(buf[1:]) // change to: err = mrand.Read(buf[1:])
+		randomize(buf[1:])
 		buf[0] = byte(padSize)
 		if params.Padding != nil {
 			copy(buf[1:], params.Padding)
@@ -208,7 +208,10 @@ func (msg *SentMessage) encryptSymmetric(key []byte) (salt []byte, nonce []byte,
 	_, err = crand.Read(nonce)
 	if err != nil {
 		return nil, nil, err
+	} else if !validateSymmetricKey(nonce) {
+		return nil, nil, errors.New("crypto/rand failed to generate nonce")
 	}
+
 	msg.Raw = aesgcm.Seal(nil, nonce, msg.Raw, nil)
 	return salt, nonce, nil
 }

whisper/whisperv5/message_test.go

@@ -57,17 +57,15 @@ func generateMessageParams() (*MessageParams, error) {
 	return &p, nil
 }
 
-func singleMessageTest(x *testing.T, symmetric bool) {
+func singleMessageTest(t *testing.T, symmetric bool) {
 	params, err := generateMessageParams()
 	if err != nil {
-		x.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 
 	key, err := crypto.GenerateKey()
 	if err != nil {
-		x.Errorf("failed GenerateKey with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed GenerateKey with seed %d: %s.", seed, err)
 	}
 
 	if !symmetric {
@@ -85,8 +83,7 @@ func singleMessageTest(x *testing.T, symmetric bool) {
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		x.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 
 	var decrypted *ReceivedMessage
@@ -97,57 +94,49 @@ func singleMessageTest(x *testing.T, symmetric bool) {
 	}
 
 	if err != nil {
-		x.Errorf("failed to encrypt with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed to encrypt with seed %d: %s.", seed, err)
 	}
 
 	if !decrypted.Validate() {
-		x.Errorf("failed to validate with seed %d.", seed)
-		return
+		t.Fatalf("failed to validate with seed %d.", seed)
 	}
 
 	padsz := len(decrypted.Padding)
 	if bytes.Compare(steg[:padsz], decrypted.Padding) != 0 {
-		x.Errorf("failed with seed %d: compare padding.", seed)
-		return
+		t.Fatalf("failed with seed %d: compare padding.", seed)
 	}
 	if bytes.Compare(text, decrypted.Payload) != 0 {
-		x.Errorf("failed with seed %d: compare payload.", seed)
-		return
+		t.Fatalf("failed with seed %d: compare payload.", seed)
 	}
 	if !isMessageSigned(decrypted.Raw[0]) {
-		x.Errorf("failed with seed %d: unsigned.", seed)
-		return
+		t.Fatalf("failed with seed %d: unsigned.", seed)
 	}
 	if len(decrypted.Signature) != signatureLength {
-		x.Errorf("failed with seed %d: signature len %d.", seed, len(decrypted.Signature))
-		return
+		t.Fatalf("failed with seed %d: signature len %d.", seed, len(decrypted.Signature))
 	}
 	if !isPubKeyEqual(decrypted.Src, &params.Src.PublicKey) {
-		x.Errorf("failed with seed %d: signature mismatch.", seed)
-		return
+		t.Fatalf("failed with seed %d: signature mismatch.", seed)
 	}
 }
 
-func TestMessageEncryption(x *testing.T) {
+func TestMessageEncryption(t *testing.T) {
 	InitSingleTest()
 
 	var symmetric bool
 	for i := 0; i < 256; i++ {
-		singleMessageTest(x, symmetric)
+		singleMessageTest(t, symmetric)
 		symmetric = !symmetric
 	}
 }
 
-func TestMessageWrap(x *testing.T) {
+func TestMessageWrap(t *testing.T) {
 	seed = int64(1777444222)
 	rand.Seed(seed)
 	target := 128.0
 
 	params, err := generateMessageParams()
 	if err != nil {
-		x.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 
 	msg := NewSentMessage(params)
@@ -156,26 +145,23 @@ func TestMessageWrap(x *testing.T) {
 	params.PoW = target
 	env, err := msg.Wrap(params)
 	if err != nil {
-		x.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 
 	pow := env.PoW()
 	if pow < target {
-		x.Errorf("failed Wrap with seed %d: pow < target (%f vs. %f).", seed, pow, target)
-		return
+		t.Fatalf("failed Wrap with seed %d: pow < target (%f vs. %f).", seed, pow, target)
 	}
 }
 
-func TestMessageSeal(x *testing.T) {
+func TestMessageSeal(t *testing.T) {
 	// this test depends on deterministic choice of seed (1976726903)
 	seed = int64(1976726903)
 	rand.Seed(seed)
 
 	params, err := generateMessageParams()
 	if err != nil {
-		x.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 
 	msg := NewSentMessage(params)
@@ -187,8 +173,7 @@ func TestMessageSeal(x *testing.T) {
 
 	env := NewEnvelope(params.TTL, params.Topic, salt, aesnonce, msg)
 	if err != nil {
-		x.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 
 	env.Expiry = uint32(seed) // make it deterministic
@@ -200,8 +185,7 @@ func TestMessageSeal(x *testing.T) {
 	env.calculatePoW(0)
 	pow := env.PoW()
 	if pow < target {
-		x.Errorf("failed Wrap with seed %d: pow < target (%f vs. %f).", seed, pow, target)
-		return
+		t.Fatalf("failed Wrap with seed %d: pow < target (%f vs. %f).", seed, pow, target)
 	}
 
 	params.WorkTime = 1
@@ -210,32 +194,29 @@ func TestMessageSeal(x *testing.T) {
 	env.calculatePoW(0)
 	pow = env.PoW()
 	if pow < 2*target {
-		x.Errorf("failed Wrap with seed %d: pow too small %f.", seed, pow)
-		return
+		t.Fatalf("failed Wrap with seed %d: pow too small %f.", seed, pow)
 	}
 }
 
-func TestEnvelopeOpen(x *testing.T) {
+func TestEnvelopeOpen(t *testing.T) {
 	InitSingleTest()
 
 	var symmetric bool
 	for i := 0; i < 256; i++ {
-		singleEnvelopeOpenTest(x, symmetric)
+		singleEnvelopeOpenTest(t, symmetric)
 		symmetric = !symmetric
 	}
 }
 
-func singleEnvelopeOpenTest(x *testing.T, symmetric bool) {
+func singleEnvelopeOpenTest(t *testing.T, symmetric bool) {
 	params, err := generateMessageParams()
 	if err != nil {
-		x.Errorf("failed generateMessageParams with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed generateMessageParams with seed %d: %s.", seed, err)
 	}
 
 	key, err := crypto.GenerateKey()
 	if err != nil {
-		x.Errorf("failed GenerateKey with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed GenerateKey with seed %d: %s.", seed, err)
 	}
 
 	if !symmetric {
@@ -253,54 +234,43 @@ func singleEnvelopeOpenTest(x *testing.T, symmetric bool) {
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		x.Errorf("failed Wrap with seed %d: %s.", seed, err)
-		return
+		t.Fatalf("failed Wrap with seed %d: %s.", seed, err)
 	}
 
 	f := Filter{KeyAsym: key, KeySym: params.KeySym}
 	decrypted := env.Open(&f)
 	if decrypted == nil {
-		x.Errorf("failed to open with seed %d.", seed)
-		return
+		t.Fatalf("failed to open with seed %d.", seed)
 	}
 
 	padsz := len(decrypted.Padding)
 	if bytes.Compare(steg[:padsz], decrypted.Padding) != 0 {
-		x.Errorf("failed with seed %d: compare padding.", seed)
-		return
+		t.Fatalf("failed with seed %d: compare padding.", seed)
 	}
 	if bytes.Compare(text, decrypted.Payload) != 0 {
-		x.Errorf("failed with seed %d: compare payload.", seed)
-		return
+		t.Fatalf("failed with seed %d: compare payload.", seed)
 	}
 	if !isMessageSigned(decrypted.Raw[0]) {
-		x.Errorf("failed with seed %d: unsigned.", seed)
-		return
+		t.Fatalf("failed with seed %d: unsigned.", seed)
 	}
 	if len(decrypted.Signature) != signatureLength {
-		x.Errorf("failed with seed %d: signature len %d.", seed, len(decrypted.Signature))
-		return
+		t.Fatalf("failed with seed %d: signature len %d.", seed, len(decrypted.Signature))
 	}
 	if !isPubKeyEqual(decrypted.Src, &params.Src.PublicKey) {
-		x.Errorf("failed with seed %d: signature mismatch.", seed)
-		return
+		t.Fatalf("failed with seed %d: signature mismatch.", seed)
 	}
 	if decrypted.isAsymmetricEncryption() == symmetric {
-		x.Errorf("failed with seed %d: asymmetric %v vs. %v.", seed, decrypted.isAsymmetricEncryption(), symmetric)
-		return
+		t.Fatalf("failed with seed %d: asymmetric %v vs. %v.", seed, decrypted.isAsymmetricEncryption(), symmetric)
 	}
 	if decrypted.isSymmetricEncryption() != symmetric {
-		x.Errorf("failed with seed %d: symmetric %v vs. %v.", seed, decrypted.isSymmetricEncryption(), symmetric)
-		return
+		t.Fatalf("failed with seed %d: symmetric %v vs. %v.", seed, decrypted.isSymmetricEncryption(), symmetric)
 	}
 	if !symmetric {
 		if decrypted.Dst == nil {
-			x.Errorf("failed with seed %d: dst is nil.", seed)
-			return
+			t.Fatalf("failed with seed %d: dst is nil.", seed)
 		}
 		if !isPubKeyEqual(decrypted.Dst, &key.PublicKey) {
-			x.Errorf("failed with seed %d: Dst.", seed)
-			return
+			t.Fatalf("failed with seed %d: Dst.", seed)
 		}
 	}
 }

whisper/whisperv5/peer.go

@@ -165,6 +165,9 @@ func (p *Peer) broadcast() error {
 			p.mark(envelope)
 		}
 	}
+	if len(transmit) == 0 {
+		return nil
+	}
 	// Transmit the unknown batch (potentially empty)
 	if err := p2p.Send(p.ws, messagesCode, transmit); err != nil {
 		return err

whisper/whisperv5/peer_test.go

@@ -79,7 +79,7 @@ type TestNode struct {
 	shh     *Whisper
 	id      *ecdsa.PrivateKey
 	server  *p2p.Server
-	filerId int
+	filerId uint32
 }
 
 var result TestData
@@ -94,19 +94,19 @@ var expectedMessage []byte = []byte("per rectum ad astra")
 // 3. each node sends a number of random (undecryptable) messages,
 // 4. first node sends one expected (decryptable) message,
 // 5. checks if each node have received and decrypted exactly one message.
-func TestSimulation(x *testing.T) {
-	initialize(x)
+func TestSimulation(t *testing.T) {
+	initialize(t)
 
 	for i := 0; i < NumNodes; i++ {
-		sendMsg(x, false, i)
+		sendMsg(t, false, i)
 	}
 
-	sendMsg(x, true, 0)
-	checkPropagation(x)
+	sendMsg(t, true, 0)
+	checkPropagation(t)
 	stopServers()
 }
 
-func initialize(x *testing.T) {
+func initialize(t *testing.T) {
 	//glog.SetV(6)
 	//glog.SetToStderr(true)
 
@@ -118,14 +118,13 @@ func initialize(x *testing.T) {
 		var node TestNode
 		node.shh = NewWhisper(nil)
 		node.shh.test = true
-		tt := make([]TopicType, 0)
-		tt = append(tt, sharedTopic)
-		f := Filter{KeySym: sharedKey, Topics: tt}
+		topics := make([]TopicType, 0)
+		topics = append(topics, sharedTopic)
+		f := Filter{KeySym: sharedKey, Topics: topics}
 		node.filerId = node.shh.Watch(&f)
 		node.id, err = crypto.HexToECDSA(keys[i])
 		if err != nil {
-			x.Errorf("failed convert the key: %s.", keys[i])
-			return
+			t.Fatalf("failed convert the key: %s.", keys[i])
 		}
 		port := port0 + i
 		addr := fmt.Sprintf(":%d", port) // e.g. ":30303"
@@ -155,8 +154,7 @@ func initialize(x *testing.T) {
 
 		err = node.server.Start()
 		if err != nil {
-			x.Errorf("failed to start server %d.", i)
-			return
+			t.Fatalf("failed to start server %d.", i)
 		}
 
 		nodes[i] = &node
@@ -173,8 +171,8 @@ func stopServers() {
 	}
 }
 
-func checkPropagation(x *testing.T) {
-	if x.Failed() {
+func checkPropagation(t *testing.T) {
+	if t.Failed() {
 		return
 	}
 
@@ -187,26 +185,24 @@ func checkPropagation(x *testing.T) {
 		for i := 0; i < NumNodes; i++ {
 			f := nodes[i].shh.GetFilter(nodes[i].filerId)
 			if f == nil {
-				x.Errorf("failed to get filterId %d from node %d.", nodes[i].filerId, i)
-				return
+				t.Fatalf("failed to get filterId %d from node %d.", nodes[i].filerId, i)
 			}
 
 			mail := f.Retrieve()
-			if !validateMail(x, i, mail) {
+			if !validateMail(t, i, mail) {
 				return
 			}
 
 			if isTestComplete() {
-
 				return
 			}
 		}
 	}
 
-	x.Errorf("Test was not complete: timeout %d seconds.", iterations*cycle/1000)
+	t.Fatalf("Test was not complete: timeout %d seconds.", iterations*cycle/1000)
 }
 
-func validateMail(x *testing.T, index int, mail []*ReceivedMessage) bool {
+func validateMail(t *testing.T, index int, mail []*ReceivedMessage) bool {
 	var cnt int
 	for _, m := range mail {
 		if bytes.Compare(m.Payload, expectedMessage) == 0 {
@@ -219,7 +215,7 @@ func validateMail(x *testing.T, index int, mail []*ReceivedMessage) bool {
 		return true
 	}
 	if cnt > 1 {
-		x.Errorf("node %d received %d.", index, cnt)
+		t.Fatalf("node %d received %d.", index, cnt)
 		return false
 	}
 
@@ -228,8 +224,7 @@ func validateMail(x *testing.T, index int, mail []*ReceivedMessage) bool {
 		defer result.mutex.Unlock()
 		result.counter[index] += cnt
 		if result.counter[index] > 1 {
-			x.Errorf("node %d accumulated %d.", index, result.counter[index])
-			return false
+			t.Fatalf("node %d accumulated %d.", index, result.counter[index])
 		}
 	}
 	return true
@@ -255,8 +250,8 @@ func isTestComplete() bool {
 	return true
 }
 
-func sendMsg(x *testing.T, expected bool, id int) {
-	if x.Failed() {
+func sendMsg(t *testing.T, expected bool, id int) {
+	if t.Failed() {
 		return
 	}
 
@@ -270,38 +265,33 @@ func sendMsg(x *testing.T, expected bool, id int) {
 	msg := NewSentMessage(&opt)
 	envelope, err := msg.Wrap(&opt)
 	if err != nil {
-		x.Errorf("failed to seal message.")
-		return
+		t.Fatalf("failed to seal message.")
 	}
 
 	err = nodes[id].shh.Send(envelope)
 	if err != nil {
-		x.Errorf("failed to send message.")
-		return
+		t.Fatalf("failed to send message.")
 	}
 }
 
-func TestPeerBasic(x *testing.T) {
+func TestPeerBasic(t *testing.T) {
 	InitSingleTest()
 
 	params, err := generateMessageParams()
 	if err != nil {
-		x.Errorf("failed 1 with seed %d.", seed)
-		return
+		t.Fatalf("failed generateMessageParams with seed %d.", seed)
 	}
 
 	params.PoW = 0.001
 	msg := NewSentMessage(params)
 	env, err := msg.Wrap(params)
 	if err != nil {
-		x.Errorf("failed 2 with seed %d.", seed)
-		return
+		t.Fatalf("failed Wrap with seed %d.", seed)
 	}
 
 	p := newPeer(nil, nil, nil)
 	p.mark(env)
 	if !p.marked(env) {
-		x.Errorf("failed 3 with seed %d.", seed)
-		return
+		t.Fatalf("failed mark with seed %d.", seed)
 	}
 }

whisper/whisperv5/topic_test.go

@@ -28,11 +28,11 @@ var topicStringTests = []struct {
 	{topic: TopicType{0xf2, 0x6e, 0x77, 0x79}, str: "0xf26e7779"},
 }
 
-func TestTopicString(x *testing.T) {
+func TestTopicString(t *testing.T) {
 	for i, tst := range topicStringTests {
 		s := tst.topic.String()
 		if s != tst.str {
-			x.Errorf("failed test %d: have %s, want %s.", i, s, tst.str)
+			t.Fatalf("failed test %d: have %s, want %s.", i, s, tst.str)
 		}
 	}
 }
@@ -53,11 +53,11 @@ var bytesToTopicTests = []struct {
 	{topic: TopicType{0x00, 0x00, 0x00, 0x00}, data: nil},
 }
 
-func TestBytesToTopic(x *testing.T) {
+func TestBytesToTopic(t *testing.T) {
 	for i, tst := range bytesToTopicTests {
-		t := BytesToTopic(tst.data)
-		if t != tst.topic {
-			x.Errorf("failed test %d: have %v, want %v.", i, t, tst.topic)
+		top := BytesToTopic(tst.data)
+		if top != tst.topic {
+			t.Fatalf("failed test %d: have %v, want %v.", i, t, tst.topic)
 		}
 	}
 }
@@ -99,38 +99,38 @@ var unmarshalTestsUgly = []struct {
 	{topic: TopicType{0x01, 0x00, 0x00, 0x00}, data: []byte("00000001")},
 }
 
-func TestUnmarshalTestsGood(x *testing.T) {
+func TestUnmarshalTestsGood(t *testing.T) {
 	for i, tst := range unmarshalTestsGood {
-		var t TopicType
-		err := t.UnmarshalJSON(tst.data)
+		var top TopicType
+		err := top.UnmarshalJSON(tst.data)
 		if err != nil {
-			x.Errorf("failed test %d. input: %v.", i, tst.data)
-		} else if t != tst.topic {
-			x.Errorf("failed test %d: have %v, want %v.", i, t, tst.topic)
+			t.Fatalf("failed test %d. input: %v.", i, tst.data)
+		} else if top != tst.topic {
+			t.Fatalf("failed test %d: have %v, want %v.", i, t, tst.topic)
 		}
 	}
 }
 
-func TestUnmarshalTestsBad(x *testing.T) {
+func TestUnmarshalTestsBad(t *testing.T) {
 	// in this test UnmarshalJSON() is supposed to fail
 	for i, tst := range unmarshalTestsBad {
-		var t TopicType
-		err := t.UnmarshalJSON(tst.data)
+		var top TopicType
+		err := top.UnmarshalJSON(tst.data)
 		if err == nil {
-			x.Errorf("failed test %d. input: %v.", i, tst.data)
+			t.Fatalf("failed test %d. input: %v.", i, tst.data)
 		}
 	}
 }
 
-func TestUnmarshalTestsUgly(x *testing.T) {
+func TestUnmarshalTestsUgly(t *testing.T) {
 	// in this test UnmarshalJSON() is NOT supposed to fail, but result should be wrong
 	for i, tst := range unmarshalTestsUgly {
-		var t TopicType
-		err := t.UnmarshalJSON(tst.data)
+		var top TopicType
+		err := top.UnmarshalJSON(tst.data)
 		if err != nil {
-			x.Errorf("failed test %d. input: %v.", i, tst.data)
-		} else if t == tst.topic {
-			x.Errorf("failed test %d: have %v, want %v.", i, t, tst.topic)
+			t.Fatalf("failed test %d. input: %v.", i, tst.data)
+		} else if top == tst.topic {
+			t.Fatalf("failed test %d: have %v, want %v.", i, top, tst.topic)
 		}
 	}
 }

whisper/whisperv5/whisper.go

@@ -177,12 +177,13 @@ func (w *Whisper) GetIdentity(pubKey string) *ecdsa.PrivateKey {
 }
 
 func (w *Whisper) GenerateSymKey(name string) error {
-	buf := make([]byte, aesKeyLength*2)
-	_, err := crand.Read(buf) // todo: check how safe is this function
+	const size = aesKeyLength * 2
+	buf := make([]byte, size)
+	_, err := crand.Read(buf)
 	if err != nil {
 		return err
 	} else if !validateSymmetricKey(buf) {
-		return fmt.Errorf("crypto/rand failed to generate random data")
+		return fmt.Errorf("error in GenerateSymKey: crypto/rand failed to generate random data")
 	}
 
 	key := buf[:aesKeyLength]
@@ -245,16 +246,16 @@ func (w *Whisper) GetSymKey(name string) []byte {
 
 // Watch installs a new message handler to run in case a matching packet arrives
 // from the whisper network.
-func (w *Whisper) Watch(f *Filter) int {
+func (w *Whisper) Watch(f *Filter) uint32 {
 	return w.filters.Install(f)
 }
 
-func (w *Whisper) GetFilter(id int) *Filter {
+func (w *Whisper) GetFilter(id uint32) *Filter {
 	return w.filters.Get(id)
 }
 
 // Unwatch removes an installed message handler.
-func (w *Whisper) Unwatch(id int) {
+func (w *Whisper) Unwatch(id uint32) {
 	w.filters.Uninstall(id)
 }
 
@@ -404,7 +405,7 @@ func (wh *Whisper) add(envelope *Envelope) error {
 		return fmt.Errorf("oversized Version")
 	}
 
-	if len(envelope.AESNonce) > 12 {
+	if len(envelope.AESNonce) > AESNonceMaxLength {
 		// the standard AES GSM nonce size is 12,
 		// but const gcmStandardNonceSize cannot be accessed directly
 		return fmt.Errorf("oversized AESNonce")
@@ -507,7 +508,7 @@ func (w *Whisper) Envelopes() []*Envelope {
 }
 
 // Messages retrieves all the decrypted messages matching a filter id.
-func (w *Whisper) Messages(id int) []*ReceivedMessage {
+func (w *Whisper) Messages(id uint32) []*ReceivedMessage {
 	result := make([]*ReceivedMessage, 0)
 	w.poolMu.RLock()
 	defer w.poolMu.RUnlock()