ethstats: fix URL parser for '@' or ':' in node name/password (#21640)

Fixes the case (example below) where the value passed
to --ethstats flag would be parsed wrongly because the
node name and/or password value contained the special
characters '@' or ':'

    --ethstats "ETC Labs Metrics @meowsbits":mypass@ws://mordor.dash.fault.dev:3000
This commit is contained in:
meowsbits 2021-05-25 16:22:46 -05:00 committed by GitHub
parent 49bde05a55
commit 10962b685e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 97 additions and 9 deletions

@ -24,7 +24,6 @@ import (
"fmt" "fmt"
"math/big" "math/big"
"net/http" "net/http"
"regexp"
"runtime" "runtime"
"strconv" "strconv"
"strings" "strings"
@ -144,21 +143,43 @@ func (w *connWrapper) Close() error {
return w.conn.Close() return w.conn.Close()
} }
// parseEthstatsURL parses the netstats connection url.
// URL argument should be of the form <nodename:secret@host:port>
// If non-erroring, the returned slice contains 3 elements: [nodename, pass, host]
func parseEthstatsURL(url string) (parts []string, err error) {
err = fmt.Errorf("invalid netstats url: \"%s\", should be nodename:secret@host:port", url)
hostIndex := strings.LastIndex(url, "@")
if hostIndex == -1 || hostIndex == len(url)-1 {
return nil, err
}
preHost, host := url[:hostIndex], url[hostIndex+1:]
passIndex := strings.LastIndex(preHost, ":")
if passIndex == -1 {
return []string{preHost, "", host}, nil
}
nodename, pass := preHost[:passIndex], ""
if passIndex != len(preHost)-1 {
pass = preHost[passIndex+1:]
}
return []string{nodename, pass, host}, nil
}
// New returns a monitoring service ready for stats reporting. // New returns a monitoring service ready for stats reporting.
func New(node *node.Node, backend backend, engine consensus.Engine, url string) error { func New(node *node.Node, backend backend, engine consensus.Engine, url string) error {
// Parse the netstats connection url parts, err := parseEthstatsURL(url)
re := regexp.MustCompile("([^:@]*)(:([^@]*))?@(.+)") if err != nil {
parts := re.FindStringSubmatch(url) return err
if len(parts) != 5 {
return fmt.Errorf("invalid netstats url: \"%s\", should be nodename:secret@host:port", url)
} }
ethstats := &Service{ ethstats := &Service{
backend: backend, backend: backend,
engine: engine, engine: engine,
server: node.Server(), server: node.Server(),
node: parts[1], node: parts[0],
pass: parts[3], pass: parts[1],
host: parts[4], host: parts[2],
pongCh: make(chan struct{}), pongCh: make(chan struct{}),
histCh: make(chan []uint64, 1), histCh: make(chan []uint64, 1),
} }

67
ethstats/ethstats_test.go Normal file

@ -0,0 +1,67 @@
package ethstats
import (
"strconv"
"testing"
)
func TestParseEthstatsURL(t *testing.T) {
cases := []struct {
url string
node, pass, host string
}{
{
url: `"debug meowsbits":mypass@ws://mordor.dash.fault.dev:3000`,
node: "debug meowsbits", pass: "mypass", host: "ws://mordor.dash.fault.dev:3000",
},
{
url: `"debug @meowsbits":mypass@ws://mordor.dash.fault.dev:3000`,
node: "debug @meowsbits", pass: "mypass", host: "ws://mordor.dash.fault.dev:3000",
},
{
url: `"debug: @meowsbits":mypass@ws://mordor.dash.fault.dev:3000`,
node: "debug: @meowsbits", pass: "mypass", host: "ws://mordor.dash.fault.dev:3000",
},
{
url: `name:@ws://mordor.dash.fault.dev:3000`,
node: "name", pass: "", host: "ws://mordor.dash.fault.dev:3000",
},
{
url: `name@ws://mordor.dash.fault.dev:3000`,
node: "name", pass: "", host: "ws://mordor.dash.fault.dev:3000",
},
{
url: `:mypass@ws://mordor.dash.fault.dev:3000`,
node: "", pass: "mypass", host: "ws://mordor.dash.fault.dev:3000",
},
{
url: `:@ws://mordor.dash.fault.dev:3000`,
node: "", pass: "", host: "ws://mordor.dash.fault.dev:3000",
},
}
for i, c := range cases {
parts, err := parseEthstatsURL(c.url)
if err != nil {
t.Fatal(err)
}
node, pass, host := parts[0], parts[1], parts[2]
// unquote because the value provided will be used as a CLI flag value, so unescaped quotes will be removed
nodeUnquote, err := strconv.Unquote(node)
if err == nil {
node = nodeUnquote
}
if node != c.node {
t.Errorf("case=%d mismatch node value, got: %v ,want: %v", i, node, c.node)
}
if pass != c.pass {
t.Errorf("case=%d mismatch pass value, got: %v ,want: %v", i, pass, c.pass)
}
if host != c.host {
t.Errorf("case=%d mismatch host value, got: %v ,want: %v", i, host, c.host)
}
}
}