aboutsummaryrefslogtreecommitdiffstats
path: root/whisper/whisperv5/filter.go
blob: feb614da2598c95881b7dfba546e3c393f79117b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
// 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 <http://www.gnu.org/licenses/>.

package whisperv5

import (
    "crypto/ecdsa"
    "fmt"
    "sync"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/crypto"
    "github.com/dexon-foundation/dexon/log"
)

type Filter struct {
    Src        *ecdsa.PublicKey  // Sender of the message
    KeyAsym    *ecdsa.PrivateKey // Private Key of recipient
    KeySym     []byte            // Key associated with the Topic
    Topics     [][]byte          // Topics to filter messages with
    PoW        float64           // Proof of work as described in the Whisper spec
    AllowP2P   bool              // Indicates whether this filter is interested in direct peer-to-peer messages
    SymKeyHash common.Hash       // The Keccak256Hash of the symmetric key, needed for optimization

    Messages map[common.Hash]*ReceivedMessage
    mutex    sync.RWMutex
}

type Filters struct {
    watchers map[string]*Filter
    whisper  *Whisper
    mutex    sync.RWMutex
}

func NewFilters(w *Whisper) *Filters {
    return &Filters{
        watchers: make(map[string]*Filter),
        whisper:  w,
    }
}

func (fs *Filters) Install(watcher *Filter) (string, error) {
    if watcher.Messages == nil {
        watcher.Messages = make(map[common.Hash]*ReceivedMessage)
    }

    id, err := GenerateRandomID()
    if err != nil {
        return "", err
    }

    fs.mutex.Lock()
    defer fs.mutex.Unlock()

    if fs.watchers[id] != nil {
        return "", fmt.Errorf("failed to generate unique ID")
    }

    if watcher.expectsSymmetricEncryption() {
        watcher.SymKeyHash = crypto.Keccak256Hash(watcher.KeySym)
    }

    fs.watchers[id] = watcher
    return id, err
}

func (fs *Filters) Uninstall(id string) bool {
    fs.mutex.Lock()
    defer fs.mutex.Unlock()
    if fs.watchers[id] != nil {
        delete(fs.watchers, id)
        return true
    }
    return false
}

func (fs *Filters) Get(id string) *Filter {
    fs.mutex.RLock()
    defer fs.mutex.RUnlock()
    return fs.watchers[id]
}

func (fs *Filters) NotifyWatchers(env *Envelope, p2pMessage bool) {
    var msg *ReceivedMessage

    fs.mutex.RLock()
    defer fs.mutex.RUnlock()

    i := -1 // only used for logging info
    for _, watcher := range fs.watchers {
        i++
        if p2pMessage && !watcher.AllowP2P {
            log.Trace(fmt.Sprintf("msg [%x], filter [%d]: p2p messages are not allowed", env.Hash(), i))
            continue
        }

        var match bool
        if msg != nil {
            match = watcher.MatchMessage(msg)
        } else {
            match = watcher.MatchEnvelope(env)
            if match {
                msg = env.Open(watcher)
                if msg == nil {
                    log.Trace("processing message: failed to open", "message", env.Hash().Hex(), "filter", i)
                }
            } else {
                log.Trace("processing message: does not match", "message", env.Hash().Hex(), "filter", i)
            }
        }

        if match && msg != nil {
            log.Trace("processing message: decrypted", "hash", env.Hash().Hex())
            if watcher.Src == nil || IsPubKeyEqual(msg.Src, watcher.Src) {
                watcher.Trigger(msg)
            }
        }
    }
}

func (f *Filter) processEnvelope(env *Envelope) *ReceivedMessage {
    if f.MatchEnvelope(env) {
        msg := env.Open(f)
        if msg != nil {
            return msg
        } else {
            log.Trace("processing envelope: failed to open", "hash", env.Hash().Hex())
        }
    } else {
        log.Trace("processing envelope: does not match", "hash", env.Hash().Hex())
    }
    return nil
}

func (f *Filter) expectsAsymmetricEncryption() bool {
    return f.KeyAsym != nil
}

func (f *Filter) expectsSymmetricEncryption() bool {
    return f.KeySym != nil
}

func (f *Filter) Trigger(msg *ReceivedMessage) {
    f.mutex.Lock()
    defer f.mutex.Unlock()

    if _, exist := f.Messages[msg.EnvelopeHash]; !exist {
        f.Messages[msg.EnvelopeHash] = msg
    }
}

func (f *Filter) Retrieve() (all []*ReceivedMessage) {
    f.mutex.Lock()
    defer f.mutex.Unlock()

    all = make([]*ReceivedMessage, 0, len(f.Messages))
    for _, msg := range f.Messages {
        all = append(all, msg)
    }

    f.Messages = make(map[common.Hash]*ReceivedMessage) // delete old messages
    return all
}

func (f *Filter) MatchMessage(msg *ReceivedMessage) bool {
    if f.PoW > 0 && msg.PoW < f.PoW {
        return false
    }

    if f.expectsAsymmetricEncryption() && msg.isAsymmetricEncryption() {
        return IsPubKeyEqual(&f.KeyAsym.PublicKey, msg.Dst) && f.MatchTopic(msg.Topic)
    } else if f.expectsSymmetricEncryption() && msg.isSymmetricEncryption() {
        return f.SymKeyHash == msg.SymKeyHash && f.MatchTopic(msg.Topic)
    }
    return false
}

func (f *Filter) MatchEnvelope(envelope *Envelope) bool {
    if f.PoW > 0 && envelope.pow < f.PoW {
        return false
    }

    if f.expectsAsymmetricEncryption() && envelope.isAsymmetric() {
        return f.MatchTopic(envelope.Topic)
    } else if f.expectsSymmetricEncryption() && envelope.IsSymmetric() {
        return f.MatchTopic(envelope.Topic)
    }
    return false
}

func (f *Filter) MatchTopic(topic TopicType) bool {
    if len(f.Topics) == 0 {
        // any topic matches
        return true
    }

    for _, bt := range f.Topics {
        if matchSingleTopic(topic, bt) {
            return true
        }
    }
    return false
}

func matchSingleTopic(topic TopicType, bt []byte) bool {
    if len(bt) > TopicLength {
        bt = bt[:TopicLength]
    }

    if len(bt) == 0 {
        return false
    }

    for j, b := range bt {
        if topic[j] != b {
            return false
        }
    }
    return true
}

func IsPubKeyEqual(a, b *ecdsa.PublicKey) bool {
    if !ValidatePublicKey(a) {
        return false
    } else if !ValidatePublicKey(b) {
        return false
    }
    // the curve is always the same, just compare the points
    return a.X.Cmp(b.X) == 0 && a.Y.Cmp(b.Y) == 0
}