github.com/codysnider/go-ethereum@v1.10.18-0.20220420071915-14f4ae99222a/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/enode"
    32  	"github.com/ethereum/go-ethereum/p2p/nat"
    33  	"github.com/ethereum/go-ethereum/p2p/netutil"
    34  )
    35  
    36  func main() {
    37  	var (
    38  		listenAddr  = flag.String("addr", ":30301", "listen address")
    39  		genKey      = flag.String("genkey", "", "generate a node key")
    40  		writeAddr   = flag.Bool("writeaddress", false, "write out the node's public key and quit")
    41  		nodeKeyFile = flag.String("nodekey", "", "private key filename")
    42  		nodeKeyHex  = flag.String("nodekeyhex", "", "private key as hex (for testing)")
    43  		natdesc     = flag.String("nat", "none", "port mapping mechanism (any|none|upnp|pmp|extip:<IP>)")
    44  		netrestrict = flag.String("netrestrict", "", "restrict network communication to the given IP networks (CIDR masks)")
    45  		runv5       = flag.Bool("v5", false, "run a v5 topic discovery bootnode")
    46  		verbosity   = flag.Int("verbosity", int(log.LvlInfo), "log verbosity (0-5)")
    47  		vmodule     = flag.String("vmodule", "", "log verbosity pattern")
    48  
    49  		nodeKey *ecdsa.PrivateKey
    50  		err     error
    51  	)
    52  	flag.Parse()
    53  
    54  	glogger := log.NewGlogHandler(log.StreamHandler(os.Stderr, log.TerminalFormat(false)))
    55  	glogger.Verbosity(log.Lvl(*verbosity))
    56  	glogger.Vmodule(*vmodule)
    57  	log.Root().SetHandler(glogger)
    58  
    59  	natm, err := nat.Parse(*natdesc)
    60  	if err != nil {
    61  		utils.Fatalf("-nat: %v", err)
    62  	}
    63  	switch {
    64  	case *genKey != "":
    65  		nodeKey, err = crypto.GenerateKey()
    66  		if err != nil {
    67  			utils.Fatalf("could not generate key: %v", err)
    68  		}
    69  		if err = crypto.SaveECDSA(*genKey, nodeKey); err != nil {
    70  			utils.Fatalf("%v", err)
    71  		}
    72  		if !*writeAddr {
    73  			return
    74  		}
    75  	case *nodeKeyFile == "" && *nodeKeyHex == "":
    76  		utils.Fatalf("Use -nodekey or -nodekeyhex to specify a private key")
    77  	case *nodeKeyFile != "" && *nodeKeyHex != "":
    78  		utils.Fatalf("Options -nodekey and -nodekeyhex are mutually exclusive")
    79  	case *nodeKeyFile != "":
    80  		if nodeKey, err = crypto.LoadECDSA(*nodeKeyFile); err != nil {
    81  			utils.Fatalf("-nodekey: %v", err)
    82  		}
    83  	case *nodeKeyHex != "":
    84  		if nodeKey, err = crypto.HexToECDSA(*nodeKeyHex); err != nil {
    85  			utils.Fatalf("-nodekeyhex: %v", err)
    86  		}
    87  	}
    88  
    89  	if *writeAddr {
    90  		fmt.Printf("%x\n", crypto.FromECDSAPub(&nodeKey.PublicKey)[1:])
    91  		os.Exit(0)
    92  	}
    93  
    94  	var restrictList *netutil.Netlist
    95  	if *netrestrict != "" {
    96  		restrictList, err = netutil.ParseNetlist(*netrestrict)
    97  		if err != nil {
    98  			utils.Fatalf("-netrestrict: %v", err)
    99  		}
   100  	}
   101  
   102  	addr, err := net.ResolveUDPAddr("udp", *listenAddr)
   103  	if err != nil {
   104  		utils.Fatalf("-ResolveUDPAddr: %v", err)
   105  	}
   106  	conn, err := net.ListenUDP("udp", addr)
   107  	if err != nil {
   108  		utils.Fatalf("-ListenUDP: %v", err)
   109  	}
   110  
   111  	realaddr := conn.LocalAddr().(*net.UDPAddr)
   112  	if natm != nil {
   113  		if !realaddr.IP.IsLoopback() {
   114  			go nat.Map(natm, nil, "udp", realaddr.Port, realaddr.Port, "ethereum discovery")
   115  		}
   116  		if ext, err := natm.ExternalIP(); err == nil {
   117  			realaddr = &net.UDPAddr{IP: ext, Port: realaddr.Port}
   118  		}
   119  	}
   120  
   121  	printNotice(&nodeKey.PublicKey, *realaddr)
   122  
   123  	db, _ := enode.OpenDB("")
   124  	ln := enode.NewLocalNode(db, nodeKey)
   125  	cfg := discover.Config{
   126  		PrivateKey:  nodeKey,
   127  		NetRestrict: restrictList,
   128  	}
   129  	if *runv5 {
   130  		if _, err := discover.ListenV5(conn, ln, cfg); err != nil {
   131  			utils.Fatalf("%v", err)
   132  		}
   133  	} else {
   134  		if _, err := discover.ListenUDP(conn, ln, cfg); err != nil {
   135  			utils.Fatalf("%v", err)
   136  		}
   137  	}
   138  
   139  	select {}
   140  }
   141  
   142  func printNotice(nodeKey *ecdsa.PublicKey, addr net.UDPAddr) {
   143  	if addr.IP.IsUnspecified() {
   144  		addr.IP = net.IP{127, 0, 0, 1}
   145  	}
   146  	n := enode.NewV4(nodeKey, addr.IP, 0, addr.Port)
   147  	fmt.Println(n.URLv4())
   148  	fmt.Println("Note: you're using cmd/bootnode, a developer tool.")
   149  	fmt.Println("We recommend using a regular node as bootstrap node for production deployments.")
   150  }