github.com/bloxroute-labs/bor@v0.1.4/p2p/enode/urlv4.go (about)

     1  // Copyright 2018 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser 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  // The go-ethereum library 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 Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package enode
    18  
    19  import (
    20  	"crypto/ecdsa"
    21  	"encoding/hex"
    22  	"errors"
    23  	"fmt"
    24  	"net"
    25  	"net/url"
    26  	"regexp"
    27  	"strconv"
    28  
    29  	"github.com/maticnetwork/bor/common/math"
    30  	"github.com/maticnetwork/bor/crypto"
    31  	"github.com/maticnetwork/bor/p2p/enr"
    32  )
    33  
    34  var incompleteNodeURL = regexp.MustCompile("(?i)^(?:enode://)?([0-9a-f]+)$")
    35  
    36  // MustParseV4 parses a node URL. It panics if the URL is not valid.
    37  func MustParseV4(rawurl string) *Node {
    38  	n, err := ParseV4(rawurl)
    39  	if err != nil {
    40  		panic("invalid node URL: " + err.Error())
    41  	}
    42  	return n
    43  }
    44  
    45  // ParseV4 parses a node URL.
    46  //
    47  // There are two basic forms of node URLs:
    48  //
    49  //   - incomplete nodes, which only have the public key (node ID)
    50  //   - complete nodes, which contain the public key and IP/Port information
    51  //
    52  // For incomplete nodes, the designator must look like one of these
    53  //
    54  //    enode://<hex node id>
    55  //    <hex node id>
    56  //
    57  // For complete nodes, the node ID is encoded in the username portion
    58  // of the URL, separated from the host by an @ sign. The hostname can
    59  // only be given as an IP address, DNS domain names are not allowed.
    60  // The port in the host name section is the TCP listening port. If the
    61  // TCP and UDP (discovery) ports differ, the UDP port is specified as
    62  // query parameter "discport".
    63  //
    64  // In the following example, the node URL describes
    65  // a node with IP address 10.3.58.6, TCP listening port 30303
    66  // and UDP discovery port 30301.
    67  //
    68  //    enode://<hex node id>@10.3.58.6:30303?discport=30301
    69  func ParseV4(rawurl string) (*Node, error) {
    70  	if m := incompleteNodeURL.FindStringSubmatch(rawurl); m != nil {
    71  		id, err := parsePubkey(m[1])
    72  		if err != nil {
    73  			return nil, fmt.Errorf("invalid public key (%v)", err)
    74  		}
    75  		return NewV4(id, nil, 0, 0), nil
    76  	}
    77  	return parseComplete(rawurl)
    78  }
    79  
    80  // NewV4 creates a node from discovery v4 node information. The record
    81  // contained in the node has a zero-length signature.
    82  func NewV4(pubkey *ecdsa.PublicKey, ip net.IP, tcp, udp int) *Node {
    83  	var r enr.Record
    84  	if len(ip) > 0 {
    85  		r.Set(enr.IP(ip))
    86  	}
    87  	if udp != 0 {
    88  		r.Set(enr.UDP(udp))
    89  	}
    90  	if tcp != 0 {
    91  		r.Set(enr.TCP(tcp))
    92  	}
    93  	signV4Compat(&r, pubkey)
    94  	n, err := New(v4CompatID{}, &r)
    95  	if err != nil {
    96  		panic(err)
    97  	}
    98  	return n
    99  }
   100  
   101  // isNewV4 returns true for nodes created by NewV4.
   102  func isNewV4(n *Node) bool {
   103  	var k s256raw
   104  	return n.r.IdentityScheme() == "" && n.r.Load(&k) == nil && len(n.r.Signature()) == 0
   105  }
   106  
   107  func parseComplete(rawurl string) (*Node, error) {
   108  	var (
   109  		id               *ecdsa.PublicKey
   110  		ip               net.IP
   111  		tcpPort, udpPort uint64
   112  	)
   113  	u, err := url.Parse(rawurl)
   114  	if err != nil {
   115  		return nil, err
   116  	}
   117  	if u.Scheme != "enode" {
   118  		return nil, errors.New("invalid URL scheme, want \"enode\"")
   119  	}
   120  	// Parse the Node ID from the user portion.
   121  	if u.User == nil {
   122  		return nil, errors.New("does not contain node ID")
   123  	}
   124  	if id, err = parsePubkey(u.User.String()); err != nil {
   125  		return nil, fmt.Errorf("invalid public key (%v)", err)
   126  	}
   127  	// Parse the IP address.
   128  	host, port, err := net.SplitHostPort(u.Host)
   129  	if err != nil {
   130  		return nil, fmt.Errorf("invalid host: %v", err)
   131  	}
   132  	if ip = net.ParseIP(host); ip == nil {
   133  		return nil, errors.New("invalid IP address")
   134  	}
   135  	// Parse the port numbers.
   136  	if tcpPort, err = strconv.ParseUint(port, 10, 16); err != nil {
   137  		return nil, errors.New("invalid port")
   138  	}
   139  	udpPort = tcpPort
   140  	qv := u.Query()
   141  	if qv.Get("discport") != "" {
   142  		udpPort, err = strconv.ParseUint(qv.Get("discport"), 10, 16)
   143  		if err != nil {
   144  			return nil, errors.New("invalid discport in query")
   145  		}
   146  	}
   147  	return NewV4(id, ip, int(tcpPort), int(udpPort)), nil
   148  }
   149  
   150  // parsePubkey parses a hex-encoded secp256k1 public key.
   151  func parsePubkey(in string) (*ecdsa.PublicKey, error) {
   152  	b, err := hex.DecodeString(in)
   153  	if err != nil {
   154  		return nil, err
   155  	} else if len(b) != 64 {
   156  		return nil, fmt.Errorf("wrong length, want %d hex chars", 128)
   157  	}
   158  	b = append([]byte{0x4}, b...)
   159  	return crypto.UnmarshalPubkey(b)
   160  }
   161  
   162  func (n *Node) URLv4() string {
   163  	var (
   164  		scheme enr.ID
   165  		nodeid string
   166  		key    ecdsa.PublicKey
   167  	)
   168  	n.Load(&scheme)
   169  	n.Load((*Secp256k1)(&key))
   170  	switch {
   171  	case scheme == "v4" || key != ecdsa.PublicKey{}:
   172  		nodeid = fmt.Sprintf("%x", crypto.FromECDSAPub(&key)[1:])
   173  	default:
   174  		nodeid = fmt.Sprintf("%s.%x", scheme, n.id[:])
   175  	}
   176  	u := url.URL{Scheme: "enode"}
   177  	if n.Incomplete() {
   178  		u.Host = nodeid
   179  	} else {
   180  		addr := net.TCPAddr{IP: n.IP(), Port: n.TCP()}
   181  		u.User = url.User(nodeid)
   182  		u.Host = addr.String()
   183  		if n.UDP() != n.TCP() {
   184  			u.RawQuery = "discport=" + strconv.Itoa(n.UDP())
   185  		}
   186  	}
   187  	return u.String()
   188  }
   189  
   190  // PubkeyToIDV4 derives the v4 node address from the given public key.
   191  func PubkeyToIDV4(key *ecdsa.PublicKey) ID {
   192  	e := make([]byte, 64)
   193  	math.ReadBits(key.X, e[:len(e)/2])
   194  	math.ReadBits(key.Y, e[len(e)/2:])
   195  	return ID(crypto.Keccak256Hash(e))
   196  }