mirror of
https://gitlab.com/pulsechaincom/go-pulse.git
synced 2024-12-22 03:30:35 +00:00
90711efb0a
This adds a generic mechanism for 'dial options' in the RPC client, and also implements a specific dial option for the JWT authentication mechanism used by the engine API. Some real tests for the server-side authentication handling are also added. Co-authored-by: Joshua Gutow <jgutow@optimism.io> Co-authored-by: Felix Lange <fjl@twurst.com>
107 lines
3.1 KiB
Go
107 lines
3.1 KiB
Go
// 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 rpc
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/gorilla/websocket"
|
|
)
|
|
|
|
// ClientOption is a configuration option for the RPC client.
|
|
type ClientOption interface {
|
|
applyOption(*clientConfig)
|
|
}
|
|
|
|
type clientConfig struct {
|
|
httpClient *http.Client
|
|
httpHeaders http.Header
|
|
httpAuth HTTPAuth
|
|
|
|
wsDialer *websocket.Dialer
|
|
}
|
|
|
|
func (cfg *clientConfig) initHeaders() {
|
|
if cfg.httpHeaders == nil {
|
|
cfg.httpHeaders = make(http.Header)
|
|
}
|
|
}
|
|
|
|
func (cfg *clientConfig) setHeader(key, value string) {
|
|
cfg.initHeaders()
|
|
cfg.httpHeaders.Set(key, value)
|
|
}
|
|
|
|
type optionFunc func(*clientConfig)
|
|
|
|
func (fn optionFunc) applyOption(opt *clientConfig) {
|
|
fn(opt)
|
|
}
|
|
|
|
// WithWebsocketDialer configures the websocket.Dialer used by the RPC client.
|
|
func WithWebsocketDialer(dialer websocket.Dialer) ClientOption {
|
|
return optionFunc(func(cfg *clientConfig) {
|
|
cfg.wsDialer = &dialer
|
|
})
|
|
}
|
|
|
|
// WithHeader configures HTTP headers set by the RPC client. Headers set using this option
|
|
// will be used for both HTTP and WebSocket connections.
|
|
func WithHeader(key, value string) ClientOption {
|
|
return optionFunc(func(cfg *clientConfig) {
|
|
cfg.initHeaders()
|
|
cfg.httpHeaders.Set(key, value)
|
|
})
|
|
}
|
|
|
|
// WithHeaders configures HTTP headers set by the RPC client. Headers set using this
|
|
// option will be used for both HTTP and WebSocket connections.
|
|
func WithHeaders(headers http.Header) ClientOption {
|
|
return optionFunc(func(cfg *clientConfig) {
|
|
cfg.initHeaders()
|
|
for k, vs := range headers {
|
|
cfg.httpHeaders[k] = vs
|
|
}
|
|
})
|
|
}
|
|
|
|
// WithHTTPClient configures the http.Client used by the RPC client.
|
|
func WithHTTPClient(c *http.Client) ClientOption {
|
|
return optionFunc(func(cfg *clientConfig) {
|
|
cfg.httpClient = c
|
|
})
|
|
}
|
|
|
|
// WithHTTPAuth configures HTTP request authentication. The given provider will be called
|
|
// whenever a request is made. Note that only one authentication provider can be active at
|
|
// any time.
|
|
func WithHTTPAuth(a HTTPAuth) ClientOption {
|
|
if a == nil {
|
|
panic("nil auth")
|
|
}
|
|
return optionFunc(func(cfg *clientConfig) {
|
|
cfg.httpAuth = a
|
|
})
|
|
}
|
|
|
|
// A HTTPAuth function is called by the client whenever a HTTP request is sent.
|
|
// The function must be safe for concurrent use.
|
|
//
|
|
// Usually, HTTPAuth functions will call h.Set("authorization", "...") to add
|
|
// auth information to the request.
|
|
type HTTPAuth func(h http.Header) error
|