aboutsummaryrefslogtreecommitdiffstats
path: root/whisper/whisperv5/api.go
blob: 841bbc2babc29d005b42b18a57cc1cfc7c099bea (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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
// 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 (
    "encoding/json"
    "errors"
    "fmt"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/hexutil"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/p2p/discover"
)

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
}

// Info returns the Whisper statistics for diagnostics.
func (api *PublicWhisperAPI) Info() (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }
    return api.whisper.Stats(), nil
}

// SetMaxMessageLength sets the maximal message length allowed by this node
func (api *PublicWhisperAPI) SetMaxMessageLength(val int) error {
    if api.whisper == nil {
        return whisperOfflineErr
    }
    return api.whisper.SetMaxMessageLength(val)
}

// SetMinimumPoW sets the minimal PoW required by this node
func (api *PublicWhisperAPI) SetMinimumPoW(val float64) error {
    if api.whisper == nil {
        return whisperOfflineErr
    }
    return api.whisper.SetMinimumPoW(val)
}

// AllowP2PMessagesFromPeer marks specific peer trusted, which will allow it
// to send historic (expired) messages.
func (api *PublicWhisperAPI) AllowP2PMessagesFromPeer(enode string) error {
    if api.whisper == nil {
        return whisperOfflineErr
    }
    n, err := discover.ParseNode(enode)
    if err != nil {
        return errors.New("failed to parse enode of trusted peer: " + err.Error())
    }
    return api.whisper.AllowP2PMessagesFromPeer(n.ID[:])
}

// HasKeyPair checks if the whisper node is configured with the private key
// of the specified public pair.
func (api *PublicWhisperAPI) HasKeyPair(id string) (bool, error) {
    if api.whisper == nil {
        return false, whisperOfflineErr
    }
    return api.whisper.HasKeyPair(id), nil
}

// DeleteKeyPair deletes the specifies key if it exists.
func (api *PublicWhisperAPI) DeleteKeyPair(id string) (bool, error) {
    if api.whisper == nil {
        return false, whisperOfflineErr
    }
    return api.whisper.DeleteKeyPair(id), nil
}

// NewKeyPair generates a new cryptographic identity for the client, and injects
// it into the known identities for message decryption.
func (api *PublicWhisperAPI) NewKeyPair() (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }
    return api.whisper.NewKeyPair()
}

// GetPublicKey returns the public key for identity id
func (api *PublicWhisperAPI) GetPublicKey(id string) (hexutil.Bytes, error) {
    if api.whisper == nil {
        return nil, whisperOfflineErr
    }
    key, err := api.whisper.GetPrivateKey(id)
    if err != nil {
        return nil, err
    }
    return crypto.FromECDSAPub(&key.PublicKey), nil
}

// GetPrivateKey returns the private key for identity id
func (api *PublicWhisperAPI) GetPrivateKey(id string) (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }
    key, err := api.whisper.GetPrivateKey(id)
    if err != nil {
        return "", err
    }
    return common.ToHex(crypto.FromECDSA(key)), nil
}

// GenerateSymmetricKey generates a random symmetric key and stores it under id,
// which is then returned. Will be used in the future for session key exchange.
func (api *PublicWhisperAPI) GenerateSymmetricKey() (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }
    return api.whisper.GenerateSymKey()
}

// AddSymmetricKeyDirect stores the key, and returns its id.
func (api *PublicWhisperAPI) AddSymmetricKeyDirect(key hexutil.Bytes) (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }
    return api.whisper.AddSymKeyDirect(key)
}

// AddSymmetricKeyFromPassword generates the key from password, stores it, and returns its id.
func (api *PublicWhisperAPI) AddSymmetricKeyFromPassword(password string) (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }
    return api.whisper.AddSymKeyFromPassword(password)
}

// HasSymmetricKey returns true if there is a key associated with the given id.
// Otherwise returns false.
func (api *PublicWhisperAPI) HasSymmetricKey(id string) (bool, error) {
    if api.whisper == nil {
        return false, whisperOfflineErr
    }
    res := api.whisper.HasSymKey(id)
    return res, nil
}

// GetSymmetricKey returns the symmetric key associated with the given id.
func (api *PublicWhisperAPI) GetSymmetricKey(name string) (hexutil.Bytes, error) {
    if api.whisper == nil {
        return nil, whisperOfflineErr
    }
    b, err := api.whisper.GetSymKey(name)
    if err != nil {
        return nil, err
    }
    return b, nil
}

// DeleteSymmetricKey deletes the key associated with the name string if it exists.
func (api *PublicWhisperAPI) DeleteSymmetricKey(name string) (bool, error) {
    if api.whisper == nil {
        return false, whisperOfflineErr
    }
    res := api.whisper.DeleteSymKey(name)
    return res, nil
}

// Subscribe creates and registers a new filter to watch for inbound whisper messages.
// Returns the ID of the newly created filter.
func (api *PublicWhisperAPI) Subscribe(args WhisperFilterArgs) (string, error) {
    if api.whisper == nil {
        return "", whisperOfflineErr
    }

    filter := Filter{
        PoW:      args.MinPoW,
        Messages: make(map[common.Hash]*ReceivedMessage),
        AllowP2P: args.AllowP2P,
    }

    var err error
    for i, bt := range args.Topics {
        if len(bt) == 0 || len(bt) > 4 {
            return "", errors.New(fmt.Sprintf("subscribe: topic %d has wrong size: %d", i, len(bt)))
        }
        filter.Topics = append(filter.Topics, bt)
    }

    if err = ValidateKeyID(args.Key); err != nil {
        return "", errors.New("subscribe: " + err.Error())
    }

    if len(args.SignedWith) > 0 {
        sb := common.FromHex(args.SignedWith)
        if sb == nil {
            return "", errors.New("subscribe: SignedWith parameter is invalid")
        }
        filter.Src = crypto.ToECDSAPub(sb)
        if !ValidatePublicKey(filter.Src) {
            return "", errors.New("subscribe: invalid 'SignedWith' field")
        }
    }

    if args.Symmetric {
        if len(args.Topics) == 0 {
            return "", errors.New("subscribe: at least one topic must be specified with symmetric encryption")
        }
        symKey, err := api.whisper.GetSymKey(args.Key)
        if err != nil {
            return "", errors.New("subscribe: invalid key ID")
        }
        if !validateSymmetricKey(symKey) {
            return "", errors.New("subscribe: retrieved key is invalid")
        }
        filter.KeySym = symKey
        filter.SymKeyHash = crypto.Keccak256Hash(filter.KeySym)
    } else {
        filter.KeyAsym, err = api.whisper.GetPrivateKey(args.Key)
        if err != nil {
            return "", errors.New("subscribe: invalid key ID")
        }
        if filter.KeyAsym == nil {
            return "", errors.New("subscribe: non-existent identity provided")
        }
    }

    return api.whisper.Subscribe(&filter)
}

// Unsubscribe disables and removes an existing filter.
func (api *PublicWhisperAPI) Unsubscribe(id string) {
    api.whisper.Unsubscribe(id)
}

// GetSubscriptionMessages retrieves all the new messages matched by the corresponding
// subscription filter since the last retrieval.
func (api *PublicWhisperAPI) GetNewSubscriptionMessages(id string) []*WhisperMessage {
    f := api.whisper.GetFilter(id)
    if f != nil {
        newMail := f.Retrieve()
        return toWhisperMessages(newMail)
    }
    return toWhisperMessages(nil)
}

// GetMessages retrieves all the floating messages that match a specific subscription filter.
// It is likely to be called once per session, right after Subscribe call.
func (api *PublicWhisperAPI) GetFloatingMessages(id string) []*WhisperMessage {
    all := api.whisper.Messages(id)
    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
    }

    var err error
    params := MessageParams{
        TTL:      args.TTL,
        WorkTime: args.PowTime,
        PoW:      args.PowTarget,
        Payload:  args.Payload,
        Padding:  args.Padding,
    }

    if len(args.Key) == 0 {
        return errors.New("post: key is missing")
    }

    if len(args.SignWith) > 0 {
        params.Src, err = api.whisper.GetPrivateKey(args.SignWith)
        if err != nil {
            return err
        }
        if params.Src == nil {
            return errors.New("post: empty identity")
        }
    }

    if len(args.Topic) == TopicLength {
        params.Topic = BytesToTopic(args.Topic)
    } else if len(args.Topic) != 0 {
        return errors.New(fmt.Sprintf("post: wrong topic size %d", len(args.Topic)))
    }

    if args.Type == "sym" {
        if err = ValidateKeyID(args.Key); err != nil {
            return err
        }
        params.KeySym, err = api.whisper.GetSymKey(args.Key)
        if err != nil {
            return err
        }
        if !validateSymmetricKey(params.KeySym) {
            return errors.New("post: key for symmetric encryption is invalid")
        }
        if len(params.Topic) == 0 {
            return errors.New("post: topic is missing for symmetric encryption")
        }
    } else if args.Type == "asym" {
        kb := common.FromHex(args.Key)
        if kb == nil {
            return errors.New("post: public key for asymmetric encryption is invalid")
        }
        params.Dst = crypto.ToECDSAPub(kb)
        if !ValidatePublicKey(params.Dst) {
            return errors.New("post: public key for asymmetric encryption is invalid")
        }
    } else {
        return errors.New("post: wrong type (sym/asym)")
    }

    // encrypt and send
    message, err := NewSentMessage(&params)
    if err != nil {
        return err
    }
    envelope, err := message.Wrap(&params)
    if err != nil {
        return err
    }
    if envelope.size() > api.whisper.maxMsgLength {
        return errors.New("post: message is too big")
    }

    if len(args.TargetPeer) != 0 {
        n, err := discover.ParseNode(args.TargetPeer)
        if err != nil {
            return errors.New("post: failed to parse enode of target peer: " + err.Error())
        }
        return api.whisper.SendP2PMessage(n.ID[:], envelope)
    } else if args.PowTarget < api.whisper.minPoW {
        return errors.New("post: target PoW is less than minimum PoW, the message can not be sent")
    }

    return api.whisper.Send(envelope)
}

type PostArgs struct {
    Type       string        `json:"type"`       // "sym"/"asym" (symmetric or asymmetric)
    TTL        uint32        `json:"ttl"`        // time-to-live in seconds
    SignWith   string        `json:"signWith"`   // id of the signing key
    Key        string        `json:"key"`        // key id (in case of sym) or public key (in case of asym)
    Topic      hexutil.Bytes `json:"topic"`      // topic (4 bytes)
    Padding    hexutil.Bytes `json:"padding"`    // optional padding bytes
    Payload    hexutil.Bytes `json:"payload"`    // payload to be encrypted
    PowTime    uint32        `json:"powTime"`    // maximal time in seconds to be spent on PoW
    PowTarget  float64       `json:"powTarget"`  // minimal PoW required for this message
    TargetPeer string        `json:"targetPeer"` // peer id (for p2p message only)
}

type WhisperFilterArgs struct {
    Symmetric  bool     // encryption type
    Key        string   // id of the key to be used for decryption
    SignedWith string   // public key of the sender to be verified
    MinPoW     float64  // minimal PoW requirement
    Topics     [][]byte // list of topics (up to 4 bytes each) to match
    AllowP2P   bool     // indicates wheather direct p2p messages are allowed for this filter
}

// 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 {
        Type       string        `json:"type"`
        Key        string        `json:"key"`
        SignedWith string        `json:"signedWith"`
        MinPoW     float64       `json:"minPoW"`
        Topics     []interface{} `json:"topics"`
        AllowP2P   bool          `json:"allowP2P"`
    }
    if err := json.Unmarshal(b, &obj); err != nil {
        return err
    }

    switch obj.Type {
    case "sym":
        args.Symmetric = true
    case "asym":
        args.Symmetric = false
    default:
        return errors.New("wrong type (sym/asym)")
    }

    args.Key = obj.Key
    args.SignedWith = obj.SignedWith
    args.MinPoW = obj.MinPoW
    args.AllowP2P = obj.AllowP2P

    // 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([][]byte, 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] = x
        }
        args.Topics = topicsDecoded
    }

    return nil
}

// WhisperMessage is the RPC representation of a whisper message.
type WhisperMessage struct {
    Topic     string  `json:"topic"`
    Payload   string  `json:"payload"`
    Padding   string  `json:"padding"`
    Src       string  `json:"signedWith"`
    Dst       string  `json:"recipientPublicKey"`
    Timestamp uint32  `json:"timestamp"`
    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 {
    msg := WhisperMessage{
        Payload:   common.ToHex(message.Payload),
        Padding:   common.ToHex(message.Padding),
        Timestamp: message.Sent,
        TTL:       message.TTL,
        PoW:       message.PoW,
        Hash:      common.ToHex(message.EnvelopeHash.Bytes()),
    }

    if len(message.Topic) == TopicLength {
        msg.Topic = common.ToHex(message.Topic[:])
    }
    if message.Dst != nil {
        b := crypto.FromECDSAPub(message.Dst)
        if b != nil {
            msg.Dst = common.ToHex(b)
        }
    }
    if isMessageSigned(message.Raw[0]) {
        b := crypto.FromECDSAPub(message.SigToPubKey())
        if b != nil {
            msg.Src = common.ToHex(b)
        }
    }
    return &msg
}