github.hscsec.cn/scroll-tech/go-ethereum@v1.9.7/cmd/bootnode/main.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of go-ethereum.
     3  //
     4  // go-ethereum is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // go-ethereum is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU General Public License
    15  // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  // bootnode runs a bootstrap node for the Ethereum Discovery Protocol.
    18  package main
    19  
    20  import (
    21  	"crypto/ecdsa"
    22  	"flag"
    23  	"fmt"
    24  	"net"
    25  	"os"
    26  
    27  	"github.com/ethereum/go-ethereum/cmd/utils"
    28  	"github.com/ethereum/go-ethereum/crypto"
    29  	"github.com/ethereum/go-ethereum/log"
    30  	"github.com/ethereum/go-ethereum/p2p/discover"
    31  	"github.com/ethereum/go-ethereum/p2p/discv5"
    32  	"github.com/ethereum/go-ethereum/p2p/enode"
    33  	"github.com/ethereum/go-ethereum/p2p/nat"
    34  	"github.com/ethereum/go-ethereum/p2p/netutil"
    35  )
    36  
    37  func main() {
    38  	var (
    39  		listenAddr  = flag.String("addr", ":30301", "listen address")
    40  		genKey      = flag.String("genkey", "", "generate a node key")
    41  		writeAddr   = flag.Bool("writeaddress", false, "write out the node's public key and quit")
    42  		nodeKeyFile = flag.String("nodekey", "", "private key filename")
    43  		nodeKeyHex  = flag.String("nodekeyhex", "", "private key as hex (for testing)")
    44  		natdesc     = flag.String("nat", "none", "port mapping mechanism (any|none|upnp|pmp|extip:<IP>)")
    45  		netrestrict = flag.String("netrestrict", "", "restrict network communication to the given IP networks (CIDR masks)")
    46  		runv5       = flag.Bool("v5", false, "run a v5 topic discovery bootnode")
    47  		verbosity   = flag.Int("verbosity", int(log.LvlInfo), "log verbosity (0-9)")
    48  		vmodule     = flag.String("vmodule", "", "log verbosity pattern")
    49  
    50  		nodeKey *ecdsa.PrivateKey
    51  		err     error
    52  	)
    53  	flag.Parse()
    54  
    55  	glogger := log.NewGlogHandler(log.StreamHandler(os.Stderr, log.TerminalFormat(false)))
    56  	glogger.Verbosity(log.Lvl(*verbosity))
    57  	glogger.Vmodule(*vmodule)
    58  	log.Root().SetHandler(glogger)
    59  
    60  	natm, err := nat.Parse(*natdesc)
    61  	if err != nil {
    62  		utils.Fatalf("-nat: %v", err)
    63  	}
    64  	switch {
    65  	case *genKey != "":
    66  		nodeKey, err = crypto.GenerateKey()
    67  		if err != nil {
    68  			utils.Fatalf("could not generate key: %v", err)
    69  		}
    70  		if err = crypto.SaveECDSA(*genKey, nodeKey); err != nil {
    71  			utils.Fatalf("%v", err)
    72  		}
    73  		if !*writeAddr {
    74  			return
    75  		}
    76  	case *nodeKeyFile == "" && *nodeKeyHex == "":
    77  		utils.Fatalf("Use -nodekey or -nodekeyhex to specify a private key")
    78  	case *nodeKeyFile != "" && *nodeKeyHex != "":
    79  		utils.Fatalf("Options -nodekey and -nodekeyhex are mutually exclusive")
    80  	case *nodeKeyFile != "":
    81  		if nodeKey, err = crypto.LoadECDSA(*nodeKeyFile); err != nil {
    82  			utils.Fatalf("-nodekey: %v", err)
    83  		}
    84  	case *nodeKeyHex != "":
    85  		if nodeKey, err = crypto.HexToECDSA(*nodeKeyHex); err != nil {
    86  			utils.Fatalf("-nodekeyhex: %v", err)
    87  		}
    88  	}
    89  
    90  	if *writeAddr {
    91  		fmt.Printf("%x\n", crypto.FromECDSAPub(&nodeKey.PublicKey)[1:])
    92  		os.Exit(0)
    93  	}
    94  
    95  	var restrictList *netutil.Netlist
    96  	if *netrestrict != "" {
    97  		restrictList, err = netutil.ParseNetlist(*netrestrict)
    98  		if err != nil {
    99  			utils.Fatalf("-netrestrict: %v", err)
   100  		}
   101  	}
   102  
   103  	addr, err := net.ResolveUDPAddr("udp", *listenAddr)
   104  	if err != nil {
   105  		utils.Fatalf("-ResolveUDPAddr: %v", err)
   106  	}
   107  	conn, err := net.ListenUDP("udp", addr)
   108  	if err != nil {
   109  		utils.Fatalf("-ListenUDP: %v", err)
   110  	}
   111  
   112  	realaddr := conn.LocalAddr().(*net.UDPAddr)
   113  	if natm != nil {
   114  		if !realaddr.IP.IsLoopback() {
   115  			go nat.Map(natm, nil, "udp", realaddr.Port, realaddr.Port, "ethereum discovery")
   116  		}
   117  		if ext, err := natm.ExternalIP(); err == nil {
   118  			realaddr = &net.UDPAddr{IP: ext, Port: realaddr.Port}
   119  		}
   120  	}
   121  
   122  	printNotice(&nodeKey.PublicKey, *realaddr)
   123  
   124  	if *runv5 {
   125  		if _, err := discv5.ListenUDP(nodeKey, conn, "", restrictList); err != nil {
   126  			utils.Fatalf("%v", err)
   127  		}
   128  	} else {
   129  		db, _ := enode.OpenDB("")
   130  		ln := enode.NewLocalNode(db, nodeKey)
   131  		cfg := discover.Config{
   132  			PrivateKey:  nodeKey,
   133  			NetRestrict: restrictList,
   134  		}
   135  		if _, err := discover.ListenUDP(conn, ln, cfg); err != nil {
   136  			utils.Fatalf("%v", err)
   137  		}
   138  	}
   139  
   140  	select {}
   141  }
   142  
   143  func printNotice(nodeKey *ecdsa.PublicKey, addr net.UDPAddr) {
   144  	if addr.IP.IsUnspecified() {
   145  		addr.IP = net.IP{127, 0, 0, 1}
   146  	}
   147  	n := enode.NewV4(nodeKey, addr.IP, 0, addr.Port)
   148  	fmt.Println(n.URLv4())
   149  	fmt.Println("Note: you're using cmd/bootnode, a developer tool.")
   150  	fmt.Println("We recommend using a regular node as bootstrap node for production deployments.")
   151  }