// Copyright 2020 The go-ethereum Authors

// (original work)

// Copyright 2024 The Erigon Authors

// (modifications)

// This file is part of Erigon.

//

// Erigon is free software: you can redistribute it and/or modify

// it under the terms of the GNU Lesser General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Erigon is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

// GNU Lesser General Public License for more details.

//

// You should have received a copy of the GNU Lesser General Public License

// along with Erigon. If not, see <http://www.gnu.org/licenses/>.

package node

import (

"compress/gzip"

"context"

"errors"

"fmt"

"io"

"net"

"net/http"

"sort"

"strings"

"sync"

"sync/atomic"

"github.com/rs/cors"

"github.com/erigontech/erigon-lib/log/v3"

"github.com/erigontech/erigon/rpc"

"github.com/erigontech/erigon/rpc/rpccfg"

)

// httpConfig is the JSON-RPC/HTTP configuration.

type httpConfig struct {

Modules []string

CorsAllowedOrigins []string

Vhosts []string

Compression bool

prefix string // path prefix on which to mount http handler

}

// wsConfig is the JSON-RPC/Websocket configuration

type wsConfig struct {

Origins []string

Modules []string

prefix string // path prefix on which to mount ws handler

}

type rpcHandler struct {

http.Handler

server *rpc.Server

}

type httpServer struct {

logger log.Logger

timeouts rpccfg.HTTPTimeouts

mux http.ServeMux // registered handlers go here

mu sync.Mutex

server *http.Server

listener net.Listener // non-nil when server is running

// HTTP RPC handler things.

httpConfig httpConfig

httpHandler atomic.Value // *rpcHandler

// WebSocket handler things.

wsConfig wsConfig

wsHandler atomic.Value // *rpcHandler

// These are set by setListenAddr.

endpoint string

host string

port int

handlerNames map[string]string

}

func newHTTPServer(logger log.Logger, timeouts rpccfg.HTTPTimeouts) *httpServer {

h := &httpServer{logger: logger, timeouts: timeouts, handlerNames: make(map[string]string)}

h.httpHandler.Store((*rpcHandler)(nil))

h.wsHandler.Store((*rpcHandler)(nil))

return h

}

// setListenAddr configures the listening address of the server.

// The address can only be set while the server isn't running.

func (h *httpServer) setListenAddr(host string, port int) error {

h.mu.Lock()

defer h.mu.Unlock()

if h.listener != nil && (host != h.host || port != h.port) {

return fmt.Errorf("HTTP server already running on %s", h.endpoint)

}

h.host, h.port = host, port

h.endpoint = fmt.Sprintf("%s:%d", host, port)

return nil

}

// listenAddr returns the listening address of the server.

func (h *httpServer) listenAddr() string {

h.mu.Lock()

defer h.mu.Unlock()

if h.listener != nil {

return h.listener.Addr().String()

}

return h.endpoint

}

// start starts the HTTP server if it is enabled and not already running.

func (h *httpServer) start() error {

h.mu.Lock()

defer h.mu.Unlock()

if h.endpoint == "" || h.listener != nil {

return nil // already running or not configured

}

// Initialize the server.

h.server = &http.Server{Handler: h} // nolint

if h.timeouts != (rpccfg.HTTPTimeouts{}) {

CheckTimeouts(&h.timeouts)

h.server.ReadTimeout = h.timeouts.ReadTimeout

h.server.WriteTimeout = h.timeouts.WriteTimeout

h.server.IdleTimeout = h.timeouts.IdleTimeout

}

// Start the server.

listener, err := net.Listen("tcp", h.endpoint)

if err != nil {

// If the server fails to start, we need to clear out the RPC and WS

// configuration so they can be configured another time.

h.disableRPC()

h.disableWS()

return err

}

h.listener = listener

go h.server.Serve(listener) // nolint:errcheck

if h.wsAllowed() {

url := fmt.Sprintf("ws://%v", listener.Addr())

if h.wsConfig.prefix != "" {

url += h.wsConfig.prefix

}

h.logger.Info("WebSocket enabled", "url", url)

}

// if server is websocket only, return after logging

if !h.rpcAllowed() {

return nil

}

// Log http endpoint.

h.logger.Info("HTTP server started",

"endpoint", listener.Addr(),

"prefix", h.httpConfig.prefix,

"cors", strings.Join(h.httpConfig.CorsAllowedOrigins, ","),

"vhosts", strings.Join(h.httpConfig.Vhosts, ","),

)

// Log all handlers mounted on server.

paths := make([]string, len(h.handlerNames))

i := 0

for path := range h.handlerNames {

paths[i] = path

i++

}

sort.Strings(paths)

logged := make(map[string]bool, len(paths))

for _, path := range paths {

name := h.handlerNames[path]

if !logged[name] {

h.logger.Info(name+" enabled", "url", "http://"+listener.Addr().String()+path)

logged[name] = true

}

}

return nil

}

func (h *httpServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {

// check if ws request and serve if ws enabled

ws := h.wsHandler.Load().(*rpcHandler)

if ws != nil && isWebsocket(r) {

if checkPath(r, h.wsConfig.prefix) {

ws.ServeHTTP(w, r)

}

return

}

// if http-rpc is enabled, try to serve request

rpc := h.httpHandler.Load().(*rpcHandler)

if rpc != nil {

// First try to route in the mux.

// Requests to a path below root are handled by the mux,

// which has all the handlers registered via Node.RegisterHandler.

// These are made available when RPC is enabled.

muxHandler, pattern := h.mux.Handler(r)

if pattern != "" {

muxHandler.ServeHTTP(w, r)

return

}

if checkPath(r, h.httpConfig.prefix) {

rpc.ServeHTTP(w, r)

return

}

}

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

}

// stop shuts down the HTTP server.

func (h *httpServer) stop() {

h.mu.Lock()

defer h.mu.Unlock()

h.doStop()

}

func (h *httpServer) doStop() {

if h.listener == nil {

return // not running

}

// Shut down the server.

httpHandler := h.httpHandler.Load().(*rpcHandler)

wsHandler := h.httpHandler.Load().(*rpcHandler)

if httpHandler != nil {

h.httpHandler.Store((*rpcHandler)(nil))

httpHandler.server.Stop()

}

if wsHandler != nil {

h.wsHandler.Store((*rpcHandler)(nil))

wsHandler.server.Stop()

}

h.server.Shutdown(context.Background()) //nolint:errcheck

h.listener.Close()

h.logger.Info("HTTP server stopped", "endpoint", h.listener.Addr())

// Clear out everything to allow re-configuring it later.

h.host, h.port, h.endpoint = "", 0, ""

h.server, h.listener = nil, nil

}

// enableRPC turns on JSON-RPC over HTTP on the server.

func (h *httpServer) enableRPC(apis []rpc.API, config httpConfig, allowList rpc.AllowList) error {

h.mu.Lock()

defer h.mu.Unlock()

if h.rpcAllowed() {

return errors.New("JSON-RPC over HTTP is already enabled")

}

// Create RPC server and handler.

srv := rpc.NewServer(50, false /* traceRequests */, false /* traceSingleRequest */, true, h.logger, 0)

srv.SetAllowList(allowList)

if err := RegisterApisFromWhitelist(apis, config.Modules, srv, false, h.logger); err != nil {

return err

}

h.httpConfig = config

h.httpHandler.Store(&rpcHandler{

Handler: NewHTTPHandlerStack(srv, config.CorsAllowedOrigins, config.Vhosts, config.Compression),

server: srv,

})

return nil

}

// disableRPC stops the HTTP RPC handler. This is internal, the caller must hold h.mu.

func (h *httpServer) disableRPC() bool {

handler := h.httpHandler.Load().(*rpcHandler)

if handler != nil {

h.httpHandler.Store((*rpcHandler)(nil))

handler.server.Stop()

}

return handler != nil

}

// enableWS turns on JSON-RPC over WebSocket on the server.

func (h *httpServer) enableWS(apis []rpc.API, config wsConfig, allowList rpc.AllowList) error {

h.mu.Lock()

defer h.mu.Unlock()

if h.wsAllowed() {

return errors.New("JSON-RPC over WebSocket is already enabled")

}

// Create RPC server and handler.

srv := rpc.NewServer(50, false /* traceRequests */, false /* debugSingleRequest */, true, h.logger, 0)

srv.SetAllowList(allowList)

if err := RegisterApisFromWhitelist(apis, config.Modules, srv, false, h.logger); err != nil {

return err

}

h.wsConfig = config

h.wsHandler.Store(&rpcHandler{

Handler: srv.WebsocketHandler(config.Origins, nil, false, h.logger),

server: srv,

})

return nil

}

// disableWS disables the WebSocket handler. This is internal, the caller must hold h.mu.

func (h *httpServer) disableWS() bool {

ws := h.wsHandler.Load().(*rpcHandler)

if ws != nil {

h.wsHandler.Store((*rpcHandler)(nil))

ws.server.Stop()

}

return ws != nil

}

// rpcAllowed returns true when JSON-RPC over HTTP is enabled.

func (h *httpServer) rpcAllowed() bool {

return h.httpHandler.Load().(*rpcHandler) != nil

}

// wsAllowed returns true when JSON-RPC over WebSocket is enabled.

func (h *httpServer) wsAllowed() bool {

return h.wsHandler.Load().(*rpcHandler) != nil

}

// isWebsocket checks the header of an http request for a websocket upgrade request.

func isWebsocket(r *http.Request) bool {

return strings.ToLower(r.Header.Get("Upgrade")) == "websocket" &&

strings.Contains(strings.ToLower(r.Header.Get("Connection")), "upgrade")

}

// NewHTTPHandlerStack returns wrapped http-related handlers

func NewHTTPHandlerStack(srv http.Handler, cors []string, vhosts []string, compression bool) http.Handler {

// Wrap the CORS-handler within a host-handler

handler := newCorsHandler(srv, cors)

handler = newVHostHandler(vhosts, handler)

if compression {

handler = newGzipHandler(handler)

}

return handler

}

func newCorsHandler(srv http.Handler, allowedOrigins []string) http.Handler {

// disable CORS support if user has not specified a custom CORS configuration

if len(allowedOrigins) == 0 {

return srv

}

c := cors.New(cors.Options{

AllowedOrigins: allowedOrigins,

AllowedMethods: []string{http.MethodPost, http.MethodGet},

AllowedHeaders: []string{"*"},

MaxAge: 600,

})

return c.Handler(srv)

}

// virtualHostHandler is a handler which validates the Host-header of incoming requests.

// Using virtual hosts can help prevent DNS rebinding attacks, where a 'random' domain name points to

// the service ip address (but without CORS headers). By verifying the targeted virtual host, we can

// ensure that it's a destination that the node operator has defined.

type virtualHostHandler struct {

vhosts map[string]struct{}

next http.Handler

}

func newVHostHandler(vhosts []string, next http.Handler) http.Handler {

vhostMap := make(map[string]struct{})

for _, allowedHost := range vhosts {

vhostMap[strings.ToLower(allowedHost)] = struct{}{}

}

return &virtualHostHandler{vhostMap, next}

}

// ServeHTTP serves JSON-RPC requests over HTTP, implements http.Handler

func (h *virtualHostHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {

// if r.Host is not set, we can continue serving since a browser would set the Host header

if r.Host == "" {

h.next.ServeHTTP(w, r)

return

}

host, _, err := net.SplitHostPort(r.Host)

if err != nil {

// Either invalid (too many colons) or no port specified

host = r.Host

}

if ipAddr := net.ParseIP(host); ipAddr != nil {

// It's an IP address, we can serve that

h.next.ServeHTTP(w, r)

return

}

// Not an IP address, but a hostname. Need to validate

if _, exist := h.vhosts["*"]; exist {

h.next.ServeHTTP(w, r)

return

}

if _, exist := h.vhosts["any"]; exist {

h.next.ServeHTTP(w, r)

return

}

if _, exist := h.vhosts[strings.ToLower(host)]; exist {

h.next.ServeHTTP(w, r)

return

}

http.Error(w, "invalid host specified", http.StatusForbidden)

}

var gzPool = sync.Pool{

New: func() interface{} {

w := gzip.NewWriter(io.Discard)

return w

},

}

type gzipResponseWriter struct {

io.Writer

http.ResponseWriter

}

func (w *gzipResponseWriter) WriteHeader(status int) {

w.Header().Del("Content-Length")

w.ResponseWriter.WriteHeader(status)

}

func (w *gzipResponseWriter) Write(b []byte) (int, error) {

return w.Writer.Write(b)

}

func newGzipHandler(next http.Handler) http.Handler {

return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

if !strings.Contains(r.Header.Get("Accept-Encoding"), "gzip") {

next.ServeHTTP(w, r)

return

}

w.Header().Set("Content-Encoding", "gzip")

gz := gzPool.Get().(*gzip.Writer)

defer gzPool.Put(gz)

gz.Reset(w)

defer gz.Close()

next.ServeHTTP(&gzipResponseWriter{ResponseWriter: w, Writer: gz}, r)

})

}

// RegisterApisFromWhitelist checks the given modules' availability, generates a whitelist based on the allowed modules,

// and then registers all of the APIs exposed by the services.

func RegisterApisFromWhitelist(apis []rpc.API, modules []string, srv *rpc.Server, exposeAll bool, logger log.Logger) error {

if bad, available := checkModuleAvailability(modules, apis); len(bad) > 0 {

logger.Error("Non-existing modules in HTTP API list, please remove it", "non-existing", bad, "existing", available)

}

// Generate the whitelist based on the allowed modules

whitelist := make(map[string]bool)

for _, module := range modules {

whitelist[module] = true

}

// Register all the APIs exposed by the services

for _, api := range apis {

if exposeAll || whitelist[api.Namespace] || (len(whitelist) == 0 && api.Public) {

if err := srv.RegisterName(api.Namespace, api.Service); err != nil {

return err

}

}

}

return nil

}