mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-07-18 02:40:45 +00:00
parent
69323a2dbf
commit
10dd75e82f
8 changed files with 413 additions and 55 deletions
|
|
@ -149,11 +149,13 @@ var (
|
||||||
utils.HTTPWriteTimeoutFlag,
|
utils.HTTPWriteTimeoutFlag,
|
||||||
utils.HTTPIdleTimeoutFlag,
|
utils.HTTPIdleTimeoutFlag,
|
||||||
utils.HTTPApiFlag,
|
utils.HTTPApiFlag,
|
||||||
|
utils.HTTPPathPrefixFlag,
|
||||||
utils.WSEnabledFlag,
|
utils.WSEnabledFlag,
|
||||||
utils.WSListenAddrFlag,
|
utils.WSListenAddrFlag,
|
||||||
utils.WSPortFlag,
|
utils.WSPortFlag,
|
||||||
utils.WSApiFlag,
|
utils.WSApiFlag,
|
||||||
utils.WSAllowedOriginsFlag,
|
utils.WSAllowedOriginsFlag,
|
||||||
|
utils.WSPathPrefixFlag,
|
||||||
utils.IPCDisabledFlag,
|
utils.IPCDisabledFlag,
|
||||||
utils.IPCPathFlag,
|
utils.IPCPathFlag,
|
||||||
utils.RPCGlobalTxFeeCap,
|
utils.RPCGlobalTxFeeCap,
|
||||||
|
|
|
||||||
|
|
@ -463,6 +463,12 @@ var (
|
||||||
Value: "debug,eth,net,personal,txpool,web3,XDPoS",
|
Value: "debug,eth,net,personal,txpool,web3,XDPoS",
|
||||||
Category: flags.APICategory,
|
Category: flags.APICategory,
|
||||||
}
|
}
|
||||||
|
HTTPPathPrefixFlag = &cli.StringFlag{
|
||||||
|
Name: "http-rpcprefix",
|
||||||
|
Usage: "HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
|
||||||
|
Value: "",
|
||||||
|
Category: flags.APICategory,
|
||||||
|
}
|
||||||
HTTPReadTimeoutFlag = &cli.DurationFlag{
|
HTTPReadTimeoutFlag = &cli.DurationFlag{
|
||||||
Name: "http-readtimeout",
|
Name: "http-readtimeout",
|
||||||
Aliases: []string{"rpcreadtimeout"},
|
Aliases: []string{"rpcreadtimeout"},
|
||||||
|
|
@ -518,6 +524,12 @@ var (
|
||||||
Value: "*",
|
Value: "*",
|
||||||
Category: flags.APICategory,
|
Category: flags.APICategory,
|
||||||
}
|
}
|
||||||
|
WSPathPrefixFlag = &cli.StringFlag{
|
||||||
|
Name: "ws-rpcprefix",
|
||||||
|
Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
|
||||||
|
Value: "",
|
||||||
|
Category: flags.APICategory,
|
||||||
|
}
|
||||||
ExecFlag = &cli.StringFlag{
|
ExecFlag = &cli.StringFlag{
|
||||||
Name: "exec",
|
Name: "exec",
|
||||||
Usage: "Execute JavaScript statement",
|
Usage: "Execute JavaScript statement",
|
||||||
|
|
@ -982,6 +994,9 @@ func setHTTP(ctx *cli.Context, cfg *node.Config) {
|
||||||
if ctx.IsSet(HTTPPortFlag.Name) {
|
if ctx.IsSet(HTTPPortFlag.Name) {
|
||||||
cfg.HTTPPort = ctx.Int(HTTPPortFlag.Name)
|
cfg.HTTPPort = ctx.Int(HTTPPortFlag.Name)
|
||||||
}
|
}
|
||||||
|
if ctx.IsSet(HTTPPathPrefixFlag.Name) {
|
||||||
|
cfg.HTTPPathPrefix = ctx.String(HTTPPathPrefixFlag.Name)
|
||||||
|
}
|
||||||
if ctx.IsSet(HTTPReadTimeoutFlag.Name) {
|
if ctx.IsSet(HTTPReadTimeoutFlag.Name) {
|
||||||
cfg.HTTPTimeouts.ReadTimeout = ctx.Duration(HTTPReadTimeoutFlag.Name)
|
cfg.HTTPTimeouts.ReadTimeout = ctx.Duration(HTTPReadTimeoutFlag.Name)
|
||||||
}
|
}
|
||||||
|
|
@ -1009,6 +1024,9 @@ func setWS(ctx *cli.Context, cfg *node.Config) {
|
||||||
if ctx.IsSet(WSPortFlag.Name) {
|
if ctx.IsSet(WSPortFlag.Name) {
|
||||||
cfg.WSPort = ctx.Int(WSPortFlag.Name)
|
cfg.WSPort = ctx.Int(WSPortFlag.Name)
|
||||||
}
|
}
|
||||||
|
if ctx.IsSet(WSPathPrefixFlag.Name) {
|
||||||
|
cfg.WSPathPrefix = ctx.String(WSPathPrefixFlag.Name)
|
||||||
|
}
|
||||||
cfg.WSOrigins = SplitAndTrim(ctx.String(WSAllowedOriginsFlag.Name))
|
cfg.WSOrigins = SplitAndTrim(ctx.String(WSAllowedOriginsFlag.Name))
|
||||||
cfg.WSModules = SplitAndTrim(ctx.String(WSApiFlag.Name))
|
cfg.WSModules = SplitAndTrim(ctx.String(WSApiFlag.Name))
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -244,7 +244,10 @@ func TestStartRPC(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, test := range tests {
|
for _, test := range tests {
|
||||||
|
test := test
|
||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
// Apply some sane defaults.
|
// Apply some sane defaults.
|
||||||
config := test.cfg
|
config := test.cfg
|
||||||
// config.Logger = testlog.Logger(t, log.LvlDebug)
|
// config.Logger = testlog.Logger(t, log.LvlDebug)
|
||||||
|
|
|
||||||
|
|
@ -131,6 +131,9 @@ type Config struct {
|
||||||
// interface.
|
// interface.
|
||||||
HTTPTimeouts rpc.HTTPTimeouts
|
HTTPTimeouts rpc.HTTPTimeouts
|
||||||
|
|
||||||
|
// HTTPPathPrefix specifies a path prefix on which http-rpc is to be served.
|
||||||
|
HTTPPathPrefix string `toml:",omitempty"`
|
||||||
|
|
||||||
// WSHost is the host interface on which to start the websocket RPC server. If
|
// WSHost is the host interface on which to start the websocket RPC server. If
|
||||||
// this field is empty, no websocket API endpoint will be started.
|
// this field is empty, no websocket API endpoint will be started.
|
||||||
WSHost string
|
WSHost string
|
||||||
|
|
@ -140,6 +143,9 @@ type Config struct {
|
||||||
// ephemeral nodes).
|
// ephemeral nodes).
|
||||||
WSPort int `toml:",omitempty"`
|
WSPort int `toml:",omitempty"`
|
||||||
|
|
||||||
|
// WSPathPrefix specifies a path prefix on which ws-rpc is to be served.
|
||||||
|
WSPathPrefix string `toml:",omitempty"`
|
||||||
|
|
||||||
// WSOrigins is the list of domain to accept websocket requests from. Please be
|
// WSOrigins is the list of domain to accept websocket requests from. Please be
|
||||||
// aware that the server can only act upon the HTTP request the client sends and
|
// aware that the server can only act upon the HTTP request the client sends and
|
||||||
// cannot verify the validity of the request header.
|
// cannot verify the validity of the request header.
|
||||||
|
|
|
||||||
19
node/node.go
19
node/node.go
|
|
@ -141,6 +141,14 @@ func New(conf *Config) (*Node, error) {
|
||||||
node.server.Config.NodeDatabase = node.config.NodeDB()
|
node.server.Config.NodeDatabase = node.config.NodeDB()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Check HTTP/WS prefixes are valid.
|
||||||
|
if err := validatePrefix("HTTP", conf.HTTPPathPrefix); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := validatePrefix("WebSocket", conf.WSPathPrefix); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
//make sure timeout values are meaningful
|
//make sure timeout values are meaningful
|
||||||
CheckTimeouts(&conf.HTTPTimeouts)
|
CheckTimeouts(&conf.HTTPTimeouts)
|
||||||
// Configure RPC servers.
|
// Configure RPC servers.
|
||||||
|
|
@ -357,6 +365,7 @@ func (n *Node) startRPC() error {
|
||||||
CorsAllowedOrigins: n.config.HTTPCors,
|
CorsAllowedOrigins: n.config.HTTPCors,
|
||||||
Vhosts: n.config.HTTPVirtualHosts,
|
Vhosts: n.config.HTTPVirtualHosts,
|
||||||
Modules: n.config.HTTPModules,
|
Modules: n.config.HTTPModules,
|
||||||
|
prefix: n.config.HTTPPathPrefix,
|
||||||
}
|
}
|
||||||
if err := n.http.setListenAddr(n.config.HTTPHost, n.config.HTTPPort); err != nil {
|
if err := n.http.setListenAddr(n.config.HTTPHost, n.config.HTTPPort); err != nil {
|
||||||
return err
|
return err
|
||||||
|
|
@ -372,6 +381,7 @@ func (n *Node) startRPC() error {
|
||||||
config := wsConfig{
|
config := wsConfig{
|
||||||
Modules: n.config.WSModules,
|
Modules: n.config.WSModules,
|
||||||
Origins: n.config.WSOrigins,
|
Origins: n.config.WSOrigins,
|
||||||
|
prefix: n.config.WSPathPrefix,
|
||||||
}
|
}
|
||||||
if err := server.setListenAddr(n.config.WSHost, n.config.WSPort); err != nil {
|
if err := server.setListenAddr(n.config.WSHost, n.config.WSPort); err != nil {
|
||||||
return err
|
return err
|
||||||
|
|
@ -529,17 +539,18 @@ func (n *Node) IPCEndpoint() string {
|
||||||
return n.ipc.endpoint
|
return n.ipc.endpoint
|
||||||
}
|
}
|
||||||
|
|
||||||
// HTTPEndpoint retrieves the current HTTP endpoint used by the protocol stack.
|
// HTTPEndpoint returns the URL of the HTTP server. Note that this URL does not
|
||||||
|
// contain the JSON-RPC path prefix set by HTTPPathPrefix.
|
||||||
func (n *Node) HTTPEndpoint() string {
|
func (n *Node) HTTPEndpoint() string {
|
||||||
return "http://" + n.http.listenAddr()
|
return "http://" + n.http.listenAddr()
|
||||||
}
|
}
|
||||||
|
|
||||||
// WSEndpoint retrieves the current WS endpoint used by the protocol stack.
|
// WSEndpoint returns the current JSON-RPC over WebSocket endpoint.
|
||||||
func (n *Node) WSEndpoint() string {
|
func (n *Node) WSEndpoint() string {
|
||||||
if n.http.wsAllowed() {
|
if n.http.wsAllowed() {
|
||||||
return "ws://" + n.http.listenAddr()
|
return "ws://" + n.http.listenAddr() + n.http.wsConfig.prefix
|
||||||
}
|
}
|
||||||
return "ws://" + n.ws.listenAddr()
|
return "ws://" + n.ws.listenAddr() + n.ws.wsConfig.prefix
|
||||||
}
|
}
|
||||||
|
|
||||||
// EventMux retrieves the event multiplexer used by all the network services in
|
// EventMux retrieves the event multiplexer used by all the network services in
|
||||||
|
|
|
||||||
|
|
@ -363,7 +363,7 @@ func TestLifecycleTerminationGuarantee(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Tests whether a handler can be successfully mounted on the canonical HTTP server
|
// Tests whether a handler can be successfully mounted on the canonical HTTP server
|
||||||
// on the given path
|
// on the given prefix
|
||||||
func TestRegisterHandler_Successful(t *testing.T) {
|
func TestRegisterHandler_Successful(t *testing.T) {
|
||||||
node := createNode(t, 7878, 7979)
|
node := createNode(t, 7878, 7979)
|
||||||
|
|
||||||
|
|
@ -427,6 +427,112 @@ func TestWebsocketHTTPOnSamePort_WebsocketRequest(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type rpcPrefixTest struct {
|
||||||
|
httpPrefix, wsPrefix string
|
||||||
|
// These lists paths on which JSON-RPC should be served / not served.
|
||||||
|
wantHTTP []string
|
||||||
|
wantNoHTTP []string
|
||||||
|
wantWS []string
|
||||||
|
wantNoWS []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNodeRPCPrefix(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []rpcPrefixTest{
|
||||||
|
// both off
|
||||||
|
{
|
||||||
|
httpPrefix: "", wsPrefix: "",
|
||||||
|
wantHTTP: []string{"/", "/?p=1"},
|
||||||
|
wantNoHTTP: []string{"/test", "/test?p=1"},
|
||||||
|
wantWS: []string{"/", "/?p=1"},
|
||||||
|
wantNoWS: []string{"/test", "/test?p=1"},
|
||||||
|
},
|
||||||
|
// only http prefix
|
||||||
|
{
|
||||||
|
httpPrefix: "/testprefix", wsPrefix: "",
|
||||||
|
wantHTTP: []string{"/testprefix", "/testprefix?p=1", "/testprefix/x", "/testprefix/x?p=1"},
|
||||||
|
wantNoHTTP: []string{"/", "/?p=1", "/test", "/test?p=1"},
|
||||||
|
wantWS: []string{"/", "/?p=1"},
|
||||||
|
wantNoWS: []string{"/testprefix", "/testprefix?p=1", "/test", "/test?p=1"},
|
||||||
|
},
|
||||||
|
// only ws prefix
|
||||||
|
{
|
||||||
|
httpPrefix: "", wsPrefix: "/testprefix",
|
||||||
|
wantHTTP: []string{"/", "/?p=1"},
|
||||||
|
wantNoHTTP: []string{"/testprefix", "/testprefix?p=1", "/test", "/test?p=1"},
|
||||||
|
wantWS: []string{"/testprefix", "/testprefix?p=1", "/testprefix/x", "/testprefix/x?p=1"},
|
||||||
|
wantNoWS: []string{"/", "/?p=1", "/test", "/test?p=1"},
|
||||||
|
},
|
||||||
|
// both set
|
||||||
|
{
|
||||||
|
httpPrefix: "/testprefix", wsPrefix: "/testprefix",
|
||||||
|
wantHTTP: []string{"/testprefix", "/testprefix?p=1", "/testprefix/x", "/testprefix/x?p=1"},
|
||||||
|
wantNoHTTP: []string{"/", "/?p=1", "/test", "/test?p=1"},
|
||||||
|
wantWS: []string{"/testprefix", "/testprefix?p=1", "/testprefix/x", "/testprefix/x?p=1"},
|
||||||
|
wantNoWS: []string{"/", "/?p=1", "/test", "/test?p=1"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
test := test
|
||||||
|
name := fmt.Sprintf("http=%s ws=%s", test.httpPrefix, test.wsPrefix)
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
cfg := &Config{
|
||||||
|
HTTPHost: "127.0.0.1",
|
||||||
|
HTTPPathPrefix: test.httpPrefix,
|
||||||
|
WSHost: "127.0.0.1",
|
||||||
|
WSPathPrefix: test.wsPrefix,
|
||||||
|
}
|
||||||
|
node, err := New(cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal("can't create node:", err)
|
||||||
|
}
|
||||||
|
defer node.Close()
|
||||||
|
if err := node.Start(); err != nil {
|
||||||
|
t.Fatal("can't start node:", err)
|
||||||
|
}
|
||||||
|
test.check(t, node)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (test rpcPrefixTest) check(t *testing.T, node *Node) {
|
||||||
|
t.Helper()
|
||||||
|
httpBase := "http://" + node.http.listenAddr()
|
||||||
|
wsBase := "ws://" + node.http.listenAddr()
|
||||||
|
|
||||||
|
if node.WSEndpoint() != wsBase+test.wsPrefix {
|
||||||
|
t.Errorf("Error: node has wrong WSEndpoint %q", node.WSEndpoint())
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, path := range test.wantHTTP {
|
||||||
|
resp := rpcRequest(t, httpBase+path)
|
||||||
|
if resp.StatusCode != 200 {
|
||||||
|
t.Errorf("Error: %s: bad status code %d, want 200", path, resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, path := range test.wantNoHTTP {
|
||||||
|
resp := rpcRequest(t, httpBase+path)
|
||||||
|
if resp.StatusCode != 404 {
|
||||||
|
t.Errorf("Error: %s: bad status code %d, want 404", path, resp.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, path := range test.wantWS {
|
||||||
|
err := wsRequest(t, wsBase+path, "")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Error: %s: WebSocket connection failed: %v", path, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, path := range test.wantNoWS {
|
||||||
|
err := wsRequest(t, wsBase+path, "")
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf("Error: %s: WebSocket connection succeeded for path in wantNoWS", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestWebsocketHTTPOnSeparatePort_WSRequest(t *testing.T) {
|
func TestWebsocketHTTPOnSeparatePort_WSRequest(t *testing.T) {
|
||||||
// try and get a free port
|
// try and get a free port
|
||||||
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
|
|
||||||
|
|
@ -39,12 +39,14 @@ type httpConfig struct {
|
||||||
Modules []string
|
Modules []string
|
||||||
CorsAllowedOrigins []string
|
CorsAllowedOrigins []string
|
||||||
Vhosts []string
|
Vhosts []string
|
||||||
|
prefix string // path prefix on which to mount http handler
|
||||||
}
|
}
|
||||||
|
|
||||||
// wsConfig is the JSON-RPC/Websocket configuration
|
// wsConfig is the JSON-RPC/Websocket configuration
|
||||||
type wsConfig struct {
|
type wsConfig struct {
|
||||||
Origins []string
|
Origins []string
|
||||||
Modules []string
|
Modules []string
|
||||||
|
prefix string // path prefix on which to mount ws handler
|
||||||
}
|
}
|
||||||
|
|
||||||
type rpcHandler struct {
|
type rpcHandler struct {
|
||||||
|
|
@ -141,12 +143,18 @@ func (h *httpServer) start() error {
|
||||||
|
|
||||||
// if server is websocket only, return after logging
|
// if server is websocket only, return after logging
|
||||||
if h.wsAllowed() && !h.rpcAllowed() {
|
if h.wsAllowed() && !h.rpcAllowed() {
|
||||||
|
url := fmt.Sprintf("ws://%v", listener.Addr())
|
||||||
|
if h.wsConfig.prefix != "" {
|
||||||
|
url += h.wsConfig.prefix
|
||||||
|
}
|
||||||
|
h.log.Info("WebSocket enabled", "url", url)
|
||||||
h.log.Info("WebSocket enabled", "url", fmt.Sprintf("ws://%v", listener.Addr()))
|
h.log.Info("WebSocket enabled", "url", fmt.Sprintf("ws://%v", listener.Addr()))
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
// Log http endpoint.
|
// Log http endpoint.
|
||||||
h.log.Info("HTTP server started",
|
h.log.Info("HTTP server started",
|
||||||
"endpoint", listener.Addr(),
|
"endpoint", listener.Addr(),
|
||||||
|
"prefix", h.httpConfig.prefix,
|
||||||
"cors", strings.Join(h.httpConfig.CorsAllowedOrigins, ","),
|
"cors", strings.Join(h.httpConfig.CorsAllowedOrigins, ","),
|
||||||
"vhosts", strings.Join(h.httpConfig.Vhosts, ","),
|
"vhosts", strings.Join(h.httpConfig.Vhosts, ","),
|
||||||
)
|
)
|
||||||
|
|
@ -169,26 +177,60 @@ func (h *httpServer) start() error {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (h *httpServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
func (h *httpServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
rpc := h.httpHandler.Load().(*rpcHandler)
|
// check if ws request and serve if ws enabled
|
||||||
if r.RequestURI == "/" {
|
ws := h.wsHandler.Load().(*rpcHandler)
|
||||||
// Serve JSON-RPC on the root path.
|
if ws != nil && isWebsocket(r) {
|
||||||
ws := h.wsHandler.Load().(*rpcHandler)
|
if checkPath(r, h.wsConfig.prefix) {
|
||||||
if ws != nil && isWebsocket(r) {
|
|
||||||
ws.ServeHTTP(w, r)
|
ws.ServeHTTP(w, r)
|
||||||
return
|
|
||||||
}
|
}
|
||||||
if rpc != nil {
|
return
|
||||||
rpc.ServeHTTP(w, r)
|
}
|
||||||
return
|
// if http-rpc is enabled, try to serve request
|
||||||
}
|
rpc := h.httpHandler.Load().(*rpcHandler)
|
||||||
} else if rpc != nil {
|
if rpc != nil {
|
||||||
|
// First try to route in the mux.
|
||||||
// Requests to a path below root are handled by the mux,
|
// Requests to a path below root are handled by the mux,
|
||||||
// which has all the handlers registered via Node.RegisterHandler.
|
// which has all the handlers registered via Node.RegisterHandler.
|
||||||
// These are made available when RPC is enabled.
|
// These are made available when RPC is enabled.
|
||||||
h.mux.ServeHTTP(w, r)
|
muxHandler, pattern := h.mux.Handler(r)
|
||||||
return
|
if pattern != "" {
|
||||||
|
muxHandler.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if checkPath(r, h.httpConfig.prefix) {
|
||||||
|
rpc.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
}
|
}
|
||||||
w.WriteHeader(404)
|
w.WriteHeader(http.StatusNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkPath checks whether a given request URL matches a given path prefix.
|
||||||
|
func checkPath(r *http.Request, path string) bool {
|
||||||
|
// if no prefix has been specified, request URL must be on root
|
||||||
|
if path == "" {
|
||||||
|
return r.URL.Path == "/"
|
||||||
|
}
|
||||||
|
// otherwise, check to make sure prefix matches
|
||||||
|
return len(r.URL.Path) >= len(path) && r.URL.Path[:len(path)] == path
|
||||||
|
}
|
||||||
|
|
||||||
|
// validatePrefix checks if 'path' is a valid configuration value for the RPC prefix option.
|
||||||
|
func validatePrefix(what, path string) error {
|
||||||
|
if path == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if path[0] != '/' {
|
||||||
|
return fmt.Errorf(`%s RPC path prefix %q does not contain leading "/"`, what, path)
|
||||||
|
}
|
||||||
|
if strings.ContainsAny(path, "?#") {
|
||||||
|
// This is just to avoid confusion. While these would match correctly (i.e. they'd
|
||||||
|
// match if URL-escaped into path), it's not easy to understand for users when
|
||||||
|
// setting that on the command line.
|
||||||
|
return fmt.Errorf("%s RPC path prefix %q contains URL meta-characters", what, path)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// stop shuts down the HTTP server.
|
// stop shuts down the HTTP server.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,11 @@ package node
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/XinFinOrg/XDPoSChain/internal/testlog"
|
"github.com/XinFinOrg/XDPoSChain/internal/testlog"
|
||||||
|
|
@ -14,57 +18,194 @@ import (
|
||||||
|
|
||||||
// TestCorsHandler makes sure CORS are properly handled on the http server.
|
// TestCorsHandler makes sure CORS are properly handled on the http server.
|
||||||
func TestCorsHandler(t *testing.T) {
|
func TestCorsHandler(t *testing.T) {
|
||||||
srv := createAndStartServer(t, httpConfig{CorsAllowedOrigins: []string{"test", "test.com"}}, false, wsConfig{})
|
srv := createAndStartServer(t, &httpConfig{CorsAllowedOrigins: []string{"test", "test.com"}}, false, &wsConfig{})
|
||||||
defer srv.stop()
|
defer srv.stop()
|
||||||
|
url := "http://" + srv.listenAddr()
|
||||||
|
|
||||||
resp := testRequest(t, "origin", "test.com", "", srv)
|
resp := rpcRequest(t, url, "origin", "test.com")
|
||||||
assert.Equal(t, "test.com", resp.Header.Get("Access-Control-Allow-Origin"))
|
assert.Equal(t, "test.com", resp.Header.Get("Access-Control-Allow-Origin"))
|
||||||
|
|
||||||
resp2 := testRequest(t, "origin", "bad", "", srv)
|
resp2 := rpcRequest(t, url, "origin", "bad")
|
||||||
assert.Equal(t, "", resp2.Header.Get("Access-Control-Allow-Origin"))
|
assert.Equal(t, "", resp2.Header.Get("Access-Control-Allow-Origin"))
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestVhosts makes sure vhosts are properly handled on the http server.
|
// TestVhosts makes sure vhosts are properly handled on the http server.
|
||||||
func TestVhosts(t *testing.T) {
|
func TestVhosts(t *testing.T) {
|
||||||
srv := createAndStartServer(t, httpConfig{Vhosts: []string{"test"}}, false, wsConfig{})
|
srv := createAndStartServer(t, &httpConfig{Vhosts: []string{"test"}}, false, &wsConfig{})
|
||||||
defer srv.stop()
|
defer srv.stop()
|
||||||
|
url := "http://" + srv.listenAddr()
|
||||||
|
|
||||||
resp := testRequest(t, "", "", "test", srv)
|
resp := rpcRequest(t, url, "host", "test")
|
||||||
assert.Equal(t, resp.StatusCode, http.StatusOK)
|
assert.Equal(t, resp.StatusCode, http.StatusOK)
|
||||||
|
|
||||||
resp2 := testRequest(t, "", "", "bad", srv)
|
resp2 := rpcRequest(t, url, "host", "bad")
|
||||||
assert.Equal(t, resp2.StatusCode, http.StatusForbidden)
|
assert.Equal(t, resp2.StatusCode, http.StatusForbidden)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type originTest struct {
|
||||||
|
spec string
|
||||||
|
expOk []string
|
||||||
|
expFail []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitAndTrim splits input separated by a comma
|
||||||
|
// and trims excessive white space from the substrings.
|
||||||
|
// Copied over from flags.go
|
||||||
|
func splitAndTrim(input string) (ret []string) {
|
||||||
|
l := strings.Split(input, ",")
|
||||||
|
for _, r := range l {
|
||||||
|
r = strings.TrimSpace(r)
|
||||||
|
if len(r) > 0 {
|
||||||
|
ret = append(ret, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
// TestWebsocketOrigins makes sure the websocket origins are properly handled on the websocket server.
|
// TestWebsocketOrigins makes sure the websocket origins are properly handled on the websocket server.
|
||||||
func TestWebsocketOrigins(t *testing.T) {
|
func TestWebsocketOrigins(t *testing.T) {
|
||||||
srv := createAndStartServer(t, httpConfig{}, true, wsConfig{Origins: []string{"test"}})
|
tests := []originTest{
|
||||||
defer srv.stop()
|
{
|
||||||
|
spec: "*", // allow all
|
||||||
dialer := websocket.DefaultDialer
|
expOk: []string{"", "http://test", "https://test", "http://test:8540", "https://test:8540",
|
||||||
_, _, err := dialer.Dial("ws://"+srv.listenAddr(), http.Header{
|
"http://test.com", "https://foo.test", "http://testa", "http://atestb:8540", "https://atestb:8540"},
|
||||||
"Content-type": []string{"application/json"},
|
},
|
||||||
"Sec-WebSocket-Version": []string{"13"},
|
{
|
||||||
"Origin": []string{"test"},
|
spec: "test",
|
||||||
})
|
expOk: []string{"http://test", "https://test", "http://test:8540", "https://test:8540"},
|
||||||
assert.NoError(t, err)
|
expFail: []string{"http://test.com", "https://foo.test", "http://testa", "http://atestb:8540", "https://atestb:8540"},
|
||||||
|
},
|
||||||
_, _, err = dialer.Dial("ws://"+srv.listenAddr(), http.Header{
|
// scheme tests
|
||||||
"Content-type": []string{"application/json"},
|
{
|
||||||
"Sec-WebSocket-Version": []string{"13"},
|
spec: "https://test",
|
||||||
"Origin": []string{"bad"},
|
expOk: []string{"https://test", "https://test:9999"},
|
||||||
})
|
expFail: []string{
|
||||||
assert.Error(t, err)
|
"test", // no scheme, required by spec
|
||||||
|
"http://test", // wrong scheme
|
||||||
|
"http://test.foo", "https://a.test.x", // subdomain variatoins
|
||||||
|
"http://testx:8540", "https://xtest:8540"},
|
||||||
|
},
|
||||||
|
// ip tests
|
||||||
|
{
|
||||||
|
spec: "https://12.34.56.78",
|
||||||
|
expOk: []string{"https://12.34.56.78", "https://12.34.56.78:8540"},
|
||||||
|
expFail: []string{
|
||||||
|
"http://12.34.56.78", // wrong scheme
|
||||||
|
"http://12.34.56.78:443", // wrong scheme
|
||||||
|
"http://1.12.34.56.78", // wrong 'domain name'
|
||||||
|
"http://12.34.56.78.a", // wrong 'domain name'
|
||||||
|
"https://87.65.43.21", "http://87.65.43.21:8540", "https://87.65.43.21:8540"},
|
||||||
|
},
|
||||||
|
// port tests
|
||||||
|
{
|
||||||
|
spec: "test:8540",
|
||||||
|
expOk: []string{"http://test:8540", "https://test:8540"},
|
||||||
|
expFail: []string{
|
||||||
|
"http://test", "https://test", // spec says port required
|
||||||
|
"http://test:8541", "https://test:8541", // wrong port
|
||||||
|
"http://bad", "https://bad", "http://bad:8540", "https://bad:8540"},
|
||||||
|
},
|
||||||
|
// scheme and port
|
||||||
|
{
|
||||||
|
spec: "https://test:8540",
|
||||||
|
expOk: []string{"https://test:8540"},
|
||||||
|
expFail: []string{
|
||||||
|
"https://test", // missing port
|
||||||
|
"http://test", // missing port, + wrong scheme
|
||||||
|
"http://test:8540", // wrong scheme
|
||||||
|
"http://test:8541", "https://test:8541", // wrong port
|
||||||
|
"http://bad", "https://bad", "http://bad:8540", "https://bad:8540"},
|
||||||
|
},
|
||||||
|
// several allowed origins
|
||||||
|
{
|
||||||
|
spec: "localhost,http://127.0.0.1",
|
||||||
|
expOk: []string{"localhost", "http://localhost", "https://localhost:8443",
|
||||||
|
"http://127.0.0.1", "http://127.0.0.1:8080"},
|
||||||
|
expFail: []string{
|
||||||
|
"https://127.0.0.1", // wrong scheme
|
||||||
|
"http://bad", "https://bad", "http://bad:8540", "https://bad:8540"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
srv := createAndStartServer(t, &httpConfig{}, true, &wsConfig{Origins: splitAndTrim(tc.spec)})
|
||||||
|
url := fmt.Sprintf("ws://%v", srv.listenAddr())
|
||||||
|
for _, origin := range tc.expOk {
|
||||||
|
if err := wsRequest(t, url, origin); err != nil {
|
||||||
|
t.Errorf("spec '%v', origin '%v': expected ok, got %v", tc.spec, origin, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, origin := range tc.expFail {
|
||||||
|
if err := wsRequest(t, url, origin); err == nil {
|
||||||
|
t.Errorf("spec '%v', origin '%v': expected not to allow, got ok", tc.spec, origin)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
srv.stop()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func createAndStartServer(t *testing.T, conf httpConfig, ws bool, wsConf wsConfig) *httpServer {
|
func Test_checkPath(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
req *http.Request
|
||||||
|
prefix string
|
||||||
|
expected bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/test"}},
|
||||||
|
prefix: "/test",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/testing"}},
|
||||||
|
prefix: "/test",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/"}},
|
||||||
|
prefix: "/test",
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/fail"}},
|
||||||
|
prefix: "/test",
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/"}},
|
||||||
|
prefix: "",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/fail"}},
|
||||||
|
prefix: "",
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/"}},
|
||||||
|
prefix: "/",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: &http.Request{URL: &url.URL{Path: "/testing"}},
|
||||||
|
prefix: "/",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, tt := range tests {
|
||||||
|
t.Run(strconv.Itoa(i), func(t *testing.T) {
|
||||||
|
assert.Equal(t, tt.expected, checkPath(tt.req, tt.prefix))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func createAndStartServer(t *testing.T, conf *httpConfig, ws bool, wsConf *wsConfig) *httpServer {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
srv := newHTTPServer(testlog.Logger(t, log.LvlDebug), rpc.DefaultHTTPTimeouts)
|
srv := newHTTPServer(testlog.Logger(t, log.LvlDebug), rpc.DefaultHTTPTimeouts)
|
||||||
|
|
||||||
assert.NoError(t, srv.enableRPC(nil, conf))
|
assert.NoError(t, srv.enableRPC(nil, *conf))
|
||||||
if ws {
|
if ws {
|
||||||
assert.NoError(t, srv.enableWS(nil, wsConf))
|
assert.NoError(t, srv.enableWS(nil, *wsConf))
|
||||||
}
|
}
|
||||||
assert.NoError(t, srv.setListenAddr("localhost", 0))
|
assert.NoError(t, srv.setListenAddr("localhost", 0))
|
||||||
assert.NoError(t, srv.start())
|
assert.NoError(t, srv.start())
|
||||||
|
|
@ -72,21 +213,50 @@ func createAndStartServer(t *testing.T, conf httpConfig, ws bool, wsConf wsConfi
|
||||||
return srv
|
return srv
|
||||||
}
|
}
|
||||||
|
|
||||||
func testRequest(t *testing.T, key, value, host string, srv *httpServer) *http.Response {
|
// wsRequest attempts to open a WebSocket connection to the given URL.
|
||||||
|
func wsRequest(t *testing.T, url, browserOrigin string) error {
|
||||||
|
t.Helper()
|
||||||
|
t.Logf("checking WebSocket on %s (origin %q)", url, browserOrigin)
|
||||||
|
|
||||||
|
headers := make(http.Header)
|
||||||
|
if browserOrigin != "" {
|
||||||
|
headers.Set("Origin", browserOrigin)
|
||||||
|
}
|
||||||
|
conn, _, err := websocket.DefaultDialer.Dial(url, headers)
|
||||||
|
if conn != nil {
|
||||||
|
conn.Close()
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// rpcRequest performs a JSON-RPC request to the given URL.
|
||||||
|
func rpcRequest(t *testing.T, url string, extraHeaders ...string) *http.Response {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
body := bytes.NewReader([]byte(`{"jsonrpc":"2.0","id":1,method":"rpc_modules"}`))
|
// Create the request.
|
||||||
req, _ := http.NewRequest("POST", "http://"+srv.listenAddr(), body)
|
body := bytes.NewReader([]byte(`{"jsonrpc":"2.0","id":1,"method":"rpc_modules","params":[]}`))
|
||||||
req.Header.Set("content-type", "application/json")
|
req, err := http.NewRequest("POST", url, body)
|
||||||
if key != "" && value != "" {
|
if err != nil {
|
||||||
req.Header.Set(key, value)
|
t.Fatal("could not create http request:", err)
|
||||||
}
|
}
|
||||||
if host != "" {
|
req.Header.Set("content-type", "application/json")
|
||||||
req.Host = host
|
|
||||||
|
// Apply extra headers.
|
||||||
|
if len(extraHeaders)%2 != 0 {
|
||||||
|
panic("odd extraHeaders length")
|
||||||
|
}
|
||||||
|
for i := 0; i < len(extraHeaders); i += 2 {
|
||||||
|
key, value := extraHeaders[i], extraHeaders[i+1]
|
||||||
|
if strings.ToLower(key) == "host" {
|
||||||
|
req.Host = value
|
||||||
|
} else {
|
||||||
|
req.Header.Set(key, value)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
client := http.DefaultClient
|
// Perform the request.
|
||||||
resp, err := client.Do(req)
|
t.Logf("checking RPC/HTTP on %s %v", url, extraHeaders)
|
||||||
|
resp, err := http.DefaultClient.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue