-
Notifications
You must be signed in to change notification settings - Fork 21.3k
cmd/geth, cmd/utils: geth attach with custom headers #25829
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
3a4da60
c5080fc
71163ce
8587327
935a30b
8ff002c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
// Copyright 2022 The go-ethereum Authors | ||
// This file is part of the go-ethereum library. | ||
// | ||
// The go-ethereum library 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. | ||
// | ||
// The go-ethereum library 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 the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
package main | ||
|
||
import ( | ||
"fmt" | ||
"net" | ||
"net/http" | ||
"sync/atomic" | ||
"testing" | ||
) | ||
|
||
type testHandler struct { | ||
body func(http.ResponseWriter, *http.Request) | ||
} | ||
|
||
func (t *testHandler) ServeHTTP(out http.ResponseWriter, in *http.Request) { | ||
t.body(out, in) | ||
} | ||
|
||
// TestAttachWithHeaders tests that 'geth attach' with custom headers works, i.e | ||
// that custom headers are forwarded to the target. | ||
func TestAttachWithHeaders(t *testing.T) { | ||
t.Parallel() | ||
ln, err := net.Listen("tcp", "localhost:0") | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
port := ln.Addr().(*net.TCPAddr).Port | ||
testReceiveHeaders(t, ln, "attach", "-H", "first: one", "-H", "second: two", fmt.Sprintf("http://localhost:%d", port)) | ||
// This way to do it fails due to flag ordering: | ||
// | ||
// testReceiveHeaders(t, ln, "-H", "first: one", "-H", "second: two", "attach", fmt.Sprintf("http://localhost:%d", port)) | ||
// This is fixed in a follow-up PR. | ||
} | ||
|
||
// TestAttachWithHeaders tests that 'geth db --remotedb' with custom headers works, i.e | ||
// that custom headers are forwarded to the target. | ||
func TestRemoteDbWithHeaders(t *testing.T) { | ||
t.Parallel() | ||
ln, err := net.Listen("tcp", "localhost:0") | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
port := ln.Addr().(*net.TCPAddr).Port | ||
testReceiveHeaders(t, ln, "db", "metadata", "--remotedb", fmt.Sprintf("http://localhost:%d", port), "-H", "first: one", "-H", "second: two") | ||
} | ||
|
||
func testReceiveHeaders(t *testing.T, ln net.Listener, gethArgs ...string) { | ||
var ok uint32 | ||
server := &http.Server{ | ||
Addr: "localhost:0", | ||
Handler: &testHandler{func(w http.ResponseWriter, r *http.Request) { | ||
// We expect two headers | ||
if have, want := r.Header.Get("first"), "one"; have != want { | ||
t.Fatalf("missing header, have %v want %v", have, want) | ||
} | ||
if have, want := r.Header.Get("second"), "two"; have != want { | ||
t.Fatalf("missing header, have %v want %v", have, want) | ||
} | ||
atomic.StoreUint32(&ok, 1) | ||
}}} | ||
go server.Serve(ln) | ||
defer server.Close() | ||
runGeth(t, gethArgs...).WaitExit() | ||
if atomic.LoadUint32(&ok) != 1 { | ||
t.Fatal("Test fail, expected invocation to succeed") | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,10 +18,13 @@ | |
package utils | ||
|
||
import ( | ||
"context" | ||
"crypto/ecdsa" | ||
"errors" | ||
"fmt" | ||
"math" | ||
"math/big" | ||
"net/http" | ||
"os" | ||
"path/filepath" | ||
godebug "runtime/debug" | ||
|
@@ -976,6 +979,13 @@ var ( | |
Value: metrics.DefaultConfig.InfluxDBOrganization, | ||
Category: flags.MetricsCategory, | ||
} | ||
|
||
HttpHeaderFlag = &cli.StringSliceFlag{ | ||
Name: "header", | ||
Aliases: []string{"H"}, | ||
Usage: "Pass custom headers to the RPC server wheng using --" + RemoteDBFlag.Name + " or the geth attach console.", | ||
Category: flags.NetworkingCategory, | ||
} | ||
) | ||
|
||
var ( | ||
|
@@ -995,6 +1005,7 @@ var ( | |
DataDirFlag, | ||
AncientFlag, | ||
RemoteDBFlag, | ||
HttpHeaderFlag, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Although I feel like it's a bit weird to put this http header flag in the database group. But it's bound with |
||
} | ||
) | ||
|
||
|
@@ -2125,8 +2136,12 @@ func MakeChainDatabase(ctx *cli.Context, stack *node.Node, readonly bool) ethdb. | |
) | ||
switch { | ||
case ctx.IsSet(RemoteDBFlag.Name): | ||
log.Info("Using remote db", "url", ctx.String(RemoteDBFlag.Name)) | ||
chainDb, err = remotedb.New(ctx.String(RemoteDBFlag.Name)) | ||
log.Info("Using remote db", "url", ctx.String(RemoteDBFlag.Name), "headers", len(ctx.StringSlice(HttpHeaderFlag.Name))) | ||
client, err := DialRPCWithHeaders(ctx.String(RemoteDBFlag.Name), ctx.StringSlice(HttpHeaderFlag.Name)) | ||
if err != nil { | ||
break | ||
} | ||
chainDb = remotedb.New(client) | ||
case ctx.String(SyncModeFlag.Name) == "light": | ||
chainDb, err = stack.OpenDatabase("lightchaindata", cache, handles, "", readonly) | ||
default: | ||
|
@@ -2148,6 +2163,30 @@ func IsNetworkPreset(ctx *cli.Context) bool { | |
return false | ||
} | ||
|
||
func DialRPCWithHeaders(endpoint string, headers []string) (*rpc.Client, error) { | ||
if endpoint == "" { | ||
return nil, errors.New("endpoint must be specified") | ||
} | ||
if strings.HasPrefix(endpoint, "rpc:") || strings.HasPrefix(endpoint, "ipc:") { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we drop this backward compatibility code? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure if we can... we never told people not to use that format, afaik |
||
// Backwards compatibility with geth < 1.5 which required | ||
// these prefixes. | ||
endpoint = endpoint[4:] | ||
} | ||
var opts []rpc.ClientOption | ||
if len(headers) > 0 { | ||
var customHeaders = make(http.Header) | ||
for _, h := range headers { | ||
kv := strings.Split(h, ":") | ||
if len(kv) != 2 { | ||
return nil, fmt.Errorf("invalid http header directive: %q", h) | ||
} | ||
customHeaders.Add(kv[0], kv[1]) | ||
} | ||
opts = append(opts, rpc.WithHeaders(customHeaders)) | ||
} | ||
return rpc.DialOptions(context.Background(), endpoint, opts...) | ||
} | ||
|
||
func MakeGenesis(ctx *cli.Context) *core.Genesis { | ||
var genesis *core.Genesis | ||
switch { | ||
|
Uh oh!
There was an error while loading. Please reload this page.