Browse Source

Feature/support https rpc client (#1816)

* Implement support for https in rpc client

* Update changelog

* update comment

* support wss protocol

* fixed changelog

* if -> switch

* fix lint

* protocol constants introduced
pull/1827/head
Roman Useinov 7 years ago
committed by Anton Kaliaev
parent
commit
f0e5332b1f
3 changed files with 42 additions and 11 deletions
  1. +6
    -0
      CHANGELOG.md
  2. +25
    -9
      rpc/lib/client/http_client.go
  3. +11
    -2
      rpc/lib/client/ws_client.go

+ 6
- 0
CHANGELOG.md View File

@ -9,6 +9,12 @@ BUG FIXES:
(`rpc.grpc_max_open_connections`). Check out [Running In (`rpc.grpc_max_open_connections`). Check out [Running In
Production](https://tendermint.readthedocs.io/en/master/running-in-production.html) Production](https://tendermint.readthedocs.io/en/master/running-in-production.html)
guide if you want to increase them. guide if you want to increase them.
## 0.21.2
IMPROVEMENT
- [rpc/client] Supports https and wss now
## 0.21.0 ## 0.21.0


+ 25
- 9
rpc/lib/client/http_client.go View File

@ -17,6 +17,14 @@ import (
types "github.com/tendermint/tendermint/rpc/lib/types" types "github.com/tendermint/tendermint/rpc/lib/types"
) )
const (
protoHTTP = "http"
protoHTTPS = "https"
protoWSS = "wss"
protoWS = "ws"
protoTCP = "tcp"
)
// HTTPClient is a common interface for JSONRPCClient and URIClient. // HTTPClient is a common interface for JSONRPCClient and URIClient.
type HTTPClient interface { type HTTPClient interface {
Call(method string, params map[string]interface{}, result interface{}) (interface{}, error) Call(method string, params map[string]interface{}, result interface{}) (interface{}, error)
@ -25,29 +33,37 @@ type HTTPClient interface {
} }
// TODO: Deprecate support for IP:PORT or /path/to/socket // TODO: Deprecate support for IP:PORT or /path/to/socket
func makeHTTPDialer(remoteAddr string) (string, func(string, string) (net.Conn, error)) {
func makeHTTPDialer(remoteAddr string) (string, string, func(string, string) (net.Conn, error)) {
// protocol to use for http operations, to support both http and https
clientProtocol := protoHTTP
parts := strings.SplitN(remoteAddr, "://", 2) parts := strings.SplitN(remoteAddr, "://", 2)
var protocol, address string var protocol, address string
if len(parts) == 1 { if len(parts) == 1 {
// default to tcp if nothing specified // default to tcp if nothing specified
protocol, address = "tcp", remoteAddr
protocol, address = protoTCP, remoteAddr
} else if len(parts) == 2 { } else if len(parts) == 2 {
protocol, address = parts[0], parts[1] protocol, address = parts[0], parts[1]
} else { } else {
// return a invalid message // return a invalid message
msg := fmt.Sprintf("Invalid addr: %s", remoteAddr) msg := fmt.Sprintf("Invalid addr: %s", remoteAddr)
return msg, func(_ string, _ string) (net.Conn, error) {
return clientProtocol, msg, func(_ string, _ string) (net.Conn, error) {
return nil, errors.New(msg) return nil, errors.New(msg)
} }
} }
// accept http as an alias for tcp
if protocol == "http" {
protocol = "tcp"
// accept http as an alias for tcp and set the client protocol
switch protocol {
case protoHTTP, protoHTTPS:
clientProtocol = protocol
protocol = protoTCP
case protoWS, protoWSS:
clientProtocol = protocol
} }
// replace / with . for http requests (kvstore domain) // replace / with . for http requests (kvstore domain)
trimmedAddress := strings.Replace(address, "/", ".", -1) trimmedAddress := strings.Replace(address, "/", ".", -1)
return trimmedAddress, func(proto, addr string) (net.Conn, error) {
return clientProtocol, trimmedAddress, func(proto, addr string) (net.Conn, error) {
return net.Dial(protocol, address) return net.Dial(protocol, address)
} }
} }
@ -55,8 +71,8 @@ func makeHTTPDialer(remoteAddr string) (string, func(string, string) (net.Conn,
// We overwrite the http.Client.Dial so we can do http over tcp or unix. // We overwrite the http.Client.Dial so we can do http over tcp or unix.
// remoteAddr should be fully featured (eg. with tcp:// or unix://) // remoteAddr should be fully featured (eg. with tcp:// or unix://)
func makeHTTPClient(remoteAddr string) (string, *http.Client) { func makeHTTPClient(remoteAddr string) (string, *http.Client) {
address, dialer := makeHTTPDialer(remoteAddr)
return "http://" + address, &http.Client{
protocol, address, dialer := makeHTTPDialer(remoteAddr)
return protocol + "://" + address, &http.Client{
Transport: &http.Transport{ Transport: &http.Transport{
Dial: dialer, Dial: dialer,
}, },


+ 11
- 2
rpc/lib/client/ws_client.go View File

@ -70,13 +70,21 @@ type WSClient struct {
// Send pings to server with this period. Must be less than readWait. If 0, no pings will be sent. // Send pings to server with this period. Must be less than readWait. If 0, no pings will be sent.
pingPeriod time.Duration pingPeriod time.Duration
// Support both ws and wss protocols
protocol string
} }
// NewWSClient returns a new client. See the commentary on the func(*WSClient) // NewWSClient returns a new client. See the commentary on the func(*WSClient)
// functions for a detailed description of how to configure ping period and // functions for a detailed description of how to configure ping period and
// pong wait time. The endpoint argument must begin with a `/`. // pong wait time. The endpoint argument must begin with a `/`.
func NewWSClient(remoteAddr, endpoint string, options ...func(*WSClient)) *WSClient { func NewWSClient(remoteAddr, endpoint string, options ...func(*WSClient)) *WSClient {
addr, dialer := makeHTTPDialer(remoteAddr)
protocol, addr, dialer := makeHTTPDialer(remoteAddr)
// default to ws protocol, unless wss is explicitly specified
if protocol != "wss" {
protocol = "ws"
}
c := &WSClient{ c := &WSClient{
cdc: amino.NewCodec(), cdc: amino.NewCodec(),
Address: addr, Address: addr,
@ -88,6 +96,7 @@ func NewWSClient(remoteAddr, endpoint string, options ...func(*WSClient)) *WSCli
readWait: defaultReadWait, readWait: defaultReadWait,
writeWait: defaultWriteWait, writeWait: defaultWriteWait,
pingPeriod: defaultPingPeriod, pingPeriod: defaultPingPeriod,
protocol: protocol,
} }
c.BaseService = *cmn.NewBaseService(nil, "WSClient", c) c.BaseService = *cmn.NewBaseService(nil, "WSClient", c)
for _, option := range options { for _, option := range options {
@ -242,7 +251,7 @@ func (c *WSClient) dial() error {
Proxy: http.ProxyFromEnvironment, Proxy: http.ProxyFromEnvironment,
} }
rHeader := http.Header{} rHeader := http.Header{}
conn, _, err := dialer.Dial("ws://"+c.Address+c.Endpoint, rHeader)
conn, _, err := dialer.Dial(c.protocol+"://"+c.Address+c.Endpoint, rHeader)
if err != nil { if err != nil {
return err return err
} }


Loading…
Cancel
Save