aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/wnode/main.go
blob: 8191f9292e1041b10d5a2211a48b8c90711c451f (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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
// Copyright 2016 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// go-ethereum 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.

// This is a simple Whisper node. It could be used as a stand-alone bootstrap node.
// Also, could be used for different test and diagnostics purposes.

package main

import (
    "bufio"
    "crypto/ecdsa"
    "crypto/sha512"
    "encoding/binary"
    "encoding/hex"
    "flag"
    "fmt"
    "os"
    "strconv"
    "strings"
    "time"

    "github.com/ethereum/go-ethereum/cmd/utils"
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/console"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/discover"
    "github.com/ethereum/go-ethereum/p2p/nat"
    "github.com/ethereum/go-ethereum/whisper/mailserver"
    whisper "github.com/ethereum/go-ethereum/whisper/whisperv5"
    "golang.org/x/crypto/pbkdf2"
)

const quitCommand = "~Q"
const symKeyName = "da919ea33001b04dfc630522e33078ec0df11"

// singletons
var (
    server     *p2p.Server
    shh        *whisper.Whisper
    done       chan struct{}
    mailServer mailserver.WMailServer

    input = bufio.NewReader(os.Stdin)
)

// encryption
var (
    symKey     []byte
    pub        *ecdsa.PublicKey
    asymKey    *ecdsa.PrivateKey
    nodeid     *ecdsa.PrivateKey
    topic      whisper.TopicType
    filterID   string
    symPass    string
    msPassword string
)

// cmd arguments
var (
    echoMode       = flag.Bool("e", false, "echo mode: prints some arguments for diagnostics")
    bootstrapMode  = flag.Bool("b", false, "boostrap node: don't actively connect to peers, wait for incoming connections")
    forwarderMode  = flag.Bool("f", false, "forwarder mode: only forward messages, neither send nor decrypt messages")
    mailServerMode = flag.Bool("s", false, "mail server mode: delivers expired messages on demand")
    requestMail    = flag.Bool("r", false, "request expired messages from the bootstrap server")
    asymmetricMode = flag.Bool("a", false, "use asymmetric encryption")
    testMode       = flag.Bool("t", false, "use of predefined parameters for diagnostics")
    generateKey    = flag.Bool("k", false, "generate and show the private key")

    argVerbosity = flag.Int("verbosity", int(log.LvlWarn), "log verbosity level")
    argTTL       = flag.Uint("ttl", 30, "time-to-live for messages in seconds")
    argWorkTime  = flag.Uint("work", 5, "work time in seconds")
    argPoW       = flag.Float64("pow", whisper.MinimumPoW, "PoW for normal messages in float format (e.g. 2.7)")
    argServerPoW = flag.Float64("mspow", whisper.MinimumPoW, "PoW requirement for Mail Server request")

    argIP     = flag.String("ip", "", "IP address and port of this node (e.g. 127.0.0.1:30303)")
    argPub    = flag.String("pub", "", "public key for asymmetric encryption")
    argDBPath = flag.String("dbpath", "", "path to the server's DB directory")
    argIDFile = flag.String("idfile", "", "file name with node id (private key)")
    argEnode  = flag.String("boot", "", "bootstrap node you want to connect to (e.g. enode://e454......08d50@52.176.211.200:16428)")
    argTopic  = flag.String("topic", "", "topic in hexadecimal format (e.g. 70a4beef)")
)

func main() {
    processArgs()
    initialize()
    run()
}

func processArgs() {
    flag.Parse()

    if len(*argIDFile) > 0 {
        var err error
        nodeid, err = crypto.LoadECDSA(*argIDFile)
        if err != nil {
            utils.Fatalf("Failed to load file [%s]: %s.", *argIDFile, err)
        }
    }

    const enodePrefix = "enode://"
    if len(*argEnode) > 0 {
        if (*argEnode)[:len(enodePrefix)] != enodePrefix {
            *argEnode = enodePrefix + *argEnode
        }
    }

    if len(*argTopic) > 0 {
        x, err := hex.DecodeString(*argTopic)
        if err != nil {
            utils.Fatalf("Failed to parse the topic: %s", err)
        }
        topic = whisper.BytesToTopic(x)
    }

    if *asymmetricMode && len(*argPub) > 0 {
        pub = crypto.ToECDSAPub(common.FromHex(*argPub))
        if !isKeyValid(pub) {
            utils.Fatalf("invalid public key")
        }
    }

    if *echoMode {
        echo()
    }
}

func echo() {
    fmt.Printf("ttl = %d \n", *argTTL)
    fmt.Printf("workTime = %d \n", *argWorkTime)
    fmt.Printf("pow = %f \n", *argPoW)
    fmt.Printf("mspow = %f \n", *argServerPoW)
    fmt.Printf("ip = %s \n", *argIP)
    fmt.Printf("pub = %s \n", common.ToHex(crypto.FromECDSAPub(pub)))
    fmt.Printf("idfile = %s \n", *argIDFile)
    fmt.Printf("dbpath = %s \n", *argDBPath)
    fmt.Printf("boot = %s \n", *argEnode)
}

func initialize() {
    log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(*argVerbosity), log.StreamHandler(os.Stderr, log.TerminalFormat())))

    done = make(chan struct{})
    var peers []*discover.Node
    var err error

    if *generateKey {
        key, err := crypto.GenerateKey()
        if err != nil {
            utils.Fatalf("Failed to generate private key: %s", err)
        }
        k := hex.EncodeToString(crypto.FromECDSA(key))
        fmt.Printf("Random private key: %s \n", k)
        os.Exit(0)
    }

    if *testMode {
        symPass = "wwww" // ascii code: 0x77777777
        msPassword = "mail server test password"
    }

    if *bootstrapMode {
        if len(*argIP) == 0 {
            argIP = scanLineA("Please enter your IP and port (e.g. 127.0.0.1:30348): ")
        }
    } else {
        if len(*argEnode) == 0 {
            argEnode = scanLineA("Please enter the peer's enode: ")
        }
        peer := discover.MustParseNode(*argEnode)
        peers = append(peers, peer)
    }

    if *mailServerMode {
        if len(msPassword) == 0 {
            msPassword, err = console.Stdin.PromptPassword("Please enter the Mail Server password: ")
            if err != nil {
                utils.Fatalf("Failed to read Mail Server password: %s", err)
            }
        }
        shh = whisper.New()
        shh.RegisterServer(&mailServer)
        mailServer.Init(shh, *argDBPath, msPassword, *argServerPoW)
    } else {
        shh = whisper.New()
    }

    asymKey = shh.NewIdentity()
    if nodeid == nil {
        nodeid = shh.NewIdentity()
    }

    maxPeers := 80
    if *bootstrapMode {
        maxPeers = 800
    }

    server = &p2p.Server{
        Config: p2p.Config{
            PrivateKey:     nodeid,
            MaxPeers:       maxPeers,
            Name:           common.MakeName("whisper-go", "5.0"),
            Protocols:      shh.Protocols(),
            ListenAddr:     *argIP,
            NAT:            nat.Any(),
            BootstrapNodes: peers,
            StaticNodes:    peers,
            TrustedNodes:   peers,
        },
    }
}

func startServer() {
    err := server.Start()
    if err != nil {
        utils.Fatalf("Failed to start Whisper peer: %s.", err)
    }

    fmt.Printf("my public key: %s \n", common.ToHex(crypto.FromECDSAPub(&asymKey.PublicKey)))
    fmt.Println(server.NodeInfo().Enode)

    if *bootstrapMode {
        configureNode()
        fmt.Println("Bootstrap Whisper node started")
    } else {
        fmt.Println("Whisper node started")
        // first see if we can establish connection, then ask for user input
        waitForConnection(true)
        configureNode()
    }

    if !*forwarderMode {
        fmt.Printf("Please type the message. To quit type: '%s'\n", quitCommand)
    }
}

func isKeyValid(k *ecdsa.PublicKey) bool {
    return k.X != nil && k.Y != nil
}

func configureNode() {
    var err error
    var p2pAccept bool

    if *forwarderMode {
        return
    }

    if *asymmetricMode {
        if len(*argPub) == 0 {
            s := scanLine("Please enter the peer's public key: ")
            pub = crypto.ToECDSAPub(common.FromHex(s))
            if !isKeyValid(pub) {
                utils.Fatalf("Error: invalid public key")
            }
        }
    }

    if *requestMail {
        p2pAccept = true
        if len(msPassword) == 0 {
            msPassword, err = console.Stdin.PromptPassword("Please enter the Mail Server password: ")
            if err != nil {
                utils.Fatalf("Failed to read Mail Server password: %s", err)
            }
        }
    }

    if !*asymmetricMode && !*forwarderMode {
        if len(symPass) == 0 {
            symPass, err = console.Stdin.PromptPassword("Please enter the password: ")
            if err != nil {
                utils.Fatalf("Failed to read passphrase: %v", err)
            }
        }

        shh.AddSymKey(symKeyName, []byte(symPass))
        symKey = shh.GetSymKey(symKeyName)
        if len(*argTopic) == 0 {
            generateTopic([]byte(symPass))
        }
    }

    if *mailServerMode {
        if len(*argDBPath) == 0 {
            argDBPath = scanLineA("Please enter the path to DB file: ")
        }
    }

    filter := whisper.Filter{
        KeySym:    symKey,
        KeyAsym:   asymKey,
        Topics:    []whisper.TopicType{topic},
        AcceptP2P: p2pAccept,
    }
    filterID, err = shh.Watch(&filter)
    if err != nil {
        utils.Fatalf("Failed to install filter: %s", err)
    }
    fmt.Printf("Filter is configured for the topic: %x \n", topic)
}

func generateTopic(password []byte) {
    x := pbkdf2.Key(password, password, 8196, 128, sha512.New)
    for i := 0; i < len(x); i++ {
        topic[i%whisper.TopicLength] ^= x[i]
    }
}

func waitForConnection(timeout bool) {
    var cnt int
    var connected bool
    for !connected {
        time.Sleep(time.Millisecond * 50)
        connected = server.PeerCount() > 0
        if timeout {
            cnt++
            if cnt > 1000 {
                utils.Fatalf("Timeout expired, failed to connect")
            }
        }
    }

    fmt.Println("Connected to peer.")
}

func run() {
    defer mailServer.Close()
    startServer()
    defer server.Stop()
    shh.Start(nil)
    defer shh.Stop()

    if !*forwarderMode {
        go messageLoop()
    }

    if *requestMail {
        requestExpiredMessagesLoop()
    } else {
        sendLoop()
    }
}

func sendLoop() {
    for {
        s := scanLine("")
        if s == quitCommand {
            fmt.Println("Quit command received")
            close(done)
            break
        }
        sendMsg([]byte(s))

        if *asymmetricMode {
            // print your own message for convenience,
            // because in asymmetric mode it is impossible to decrypt it
            timestamp := time.Now().Unix()
            from := crypto.PubkeyToAddress(asymKey.PublicKey)
            fmt.Printf("\n%d <%x>: %s\n", timestamp, from, s)
        }
    }
}

func scanLine(prompt string) string {
    if len(prompt) > 0 {
        fmt.Print(prompt)
    }
    txt, err := input.ReadString('\n')
    if err != nil {
        utils.Fatalf("input error: %s", err)
    }
    txt = strings.TrimRight(txt, "\n\r")
    return txt
}

func scanLineA(prompt string) *string {
    s := scanLine(prompt)
    return &s
}

func scanUint(prompt string) uint32 {
    s := scanLine(prompt)
    i, err := strconv.Atoi(s)
    if err != nil {
        utils.Fatalf("Fail to parse the lower time limit: %s", err)
    }
    return uint32(i)
}

func sendMsg(payload []byte) {
    params := whisper.MessageParams{
        Src:      asymKey,
        Dst:      pub,
        KeySym:   symKey,
        Payload:  payload,
        Topic:    topic,
        TTL:      uint32(*argTTL),
        PoW:      *argPoW,
        WorkTime: uint32(*argWorkTime),
    }

    msg := whisper.NewSentMessage(&params)
    envelope, err := msg.Wrap(&params)
    if err != nil {
        fmt.Printf("failed to seal message: %v \n", err)
        return
    }

    err = shh.Send(envelope)
    if err != nil {
        fmt.Printf("failed to send message: %v \n", err)
    }
}

func messageLoop() {
    f := shh.GetFilter(filterID)
    if f == nil {
        utils.Fatalf("filter is not installed")
    }

    ticker := time.NewTicker(time.Millisecond * 50)

    for {
        select {
        case <-ticker.C:
            messages := f.Retrieve()
            for _, msg := range messages {
                printMessageInfo(msg)
            }
        case <-done:
            return
        }
    }
}

func printMessageInfo(msg *whisper.ReceivedMessage) {
    timestamp := fmt.Sprintf("%d", msg.Sent) // unix timestamp for diagnostics
    text := string(msg.Payload)

    var address common.Address
    if msg.Src != nil {
        address = crypto.PubkeyToAddress(*msg.Src)
    }

    if whisper.IsPubKeyEqual(msg.Src, &asymKey.PublicKey) {
        fmt.Printf("\n%s <%x>: %s\n", timestamp, address, text) // message from myself
    } else {
        fmt.Printf("\n%s [%x]: %s\n", timestamp, address, text) // message from a peer
    }
}

func requestExpiredMessagesLoop() {
    var key, peerID []byte
    var timeLow, timeUpp uint32
    var t string
    var xt, empty whisper.TopicType

    err := shh.AddSymKey(mailserver.MailServerKeyName, []byte(msPassword))
    if err != nil {
        utils.Fatalf("Failed to create symmetric key for mail request: %s", err)
    }
    key = shh.GetSymKey(mailserver.MailServerKeyName)
    peerID = extractIdFromEnode(*argEnode)
    shh.MarkPeerTrusted(peerID)

    for {
        timeLow = scanUint("Please enter the lower limit of the time range (unix timestamp): ")
        timeUpp = scanUint("Please enter the upper limit of the time range (unix timestamp): ")
        t = scanLine("Please enter the topic (hexadecimal): ")
        if len(t) >= whisper.TopicLength*2 {
            x, err := hex.DecodeString(t)
            if err != nil {
                utils.Fatalf("Failed to parse the topic: %s", err)
            }
            xt = whisper.BytesToTopic(x)
        }
        if timeUpp == 0 {
            timeUpp = 0xFFFFFFFF
        }

        data := make([]byte, 8+whisper.TopicLength)
        binary.BigEndian.PutUint32(data, timeLow)
        binary.BigEndian.PutUint32(data[4:], timeUpp)
        copy(data[8:], xt[:])
        if xt == empty {
            data = data[:8]
        }

        var params whisper.MessageParams
        params.PoW = *argServerPoW
        params.Payload = data
        params.KeySym = key
        params.Src = nodeid
        params.WorkTime = 5

        msg := whisper.NewSentMessage(&params)
        env, err := msg.Wrap(&params)
        if err != nil {
            utils.Fatalf("Wrap failed: %s", err)
        }

        err = shh.RequestHistoricMessages(peerID, env)
        if err != nil {
            utils.Fatalf("Failed to send P2P message: %s", err)
        }

        time.Sleep(time.Second * 5)
    }
}

func extractIdFromEnode(s string) []byte {
    n, err := discover.ParseNode(s)
    if err != nil {
        utils.Fatalf("Failed to parse enode: %s", err)
        return nil
    }
    return n.ID[:]
}