Add readme and update client code

Snowflake-Labs · Nov 26, 2024 · 4e1cbab · 4e1cbab
1 parent 86a0f2f
commit 4e1cbab
Show file tree

Hide file tree

Showing 7 changed files with 119 additions and 52 deletions.
diff --git a/services/httpoverrpc/README.md b/services/httpoverrpc/README.md
@@ -0,0 +1,26 @@
+# HTTPOVERRPC
+This directory contains the http over rpc services. It is a simple service that allows to send http requests to from target hosts
+
+
+## Usage
+
+### sanssh httpoverrpc get
+Make a HTTP(-S) request to a specified port on the remote host.
+
+```bash
+sanssh <sanssh-args> get [-method <method>] [-header <header>] [-dialAddress <dial-address>] [-insecure-skip-tls-verify] [-show-response-headers] [-body <body>] [-protocol <protocol>] [-hostname <hostname>] <remoteport> <request_uri>:
+```
+
+Where:
+- `<body>` body to send in request
+- `<dial-address>` host:port to dial to. If not provided would dial to original host and port
+- `<header>` Header to send in the request, may be specified multiple times.
+- `<hostname>` ip address or domain name to specify host (default "localhost")
+- `<method>` method to use in the HTTP request (default "GET")
+- `<protocol>` protocol to communicate with specified hostname (default "http")
+- `<remoteport>` port to connect to on the remote host
+- `<request_uri>` URI to request
+
+Flags:
+- `-show-response-headers` If provided, print response code and headers
+- `-insecure-skip-tls-verify` If provided, skip TLS verification
diff --git a/services/httpoverrpc/client/client.go b/services/httpoverrpc/client/client.go
@@ -35,6 +35,7 @@ import (
 	"github.com/Snowflake-Labs/sansshell/client"
 	pb "github.com/Snowflake-Labs/sansshell/services/httpoverrpc"
 	"github.com/Snowflake-Labs/sansshell/services/util"
+	"github.com/Snowflake-Labs/sansshell/services/util/validator"
 )
 
 const subPackage = "httpoverrpc"
@@ -226,16 +227,20 @@ type getCmd struct {
 	protocol            string
 	hostname            string
 	insecureSkipVerify  bool
+	dialAddress         string
 }
 
 func (*getCmd) Name() string     { return "get" }
-func (*getCmd) Synopsis() string { return "Makes a HTTP call to a port on a remote host" }
+func (*getCmd) Synopsis() string { return "Makes a HTTP(-S) call to a port on a remote host" }
 func (*getCmd) Usage() string {
-	return `get [-method METHOD] [-header Header...] [-body body] [-protocol Protocol] [-hostname Hostname] remoteport request_uri:
+	return `get [-method METHOD] [-header Header...] [-dialAddress dialAddress] [-body body] [-protocol Protocol] [-hostname Hostname] remoteport request_uri:
   Make a HTTP request to a specified port on the remote host.
 
-  Example:
+  Examples:
+  # send get request to https://localhost:9090/hello
   httpoverrpc get --hostname 10.1.23.4 --protocol https 9090 /hello
+  # send get request with url http://example.com:9090/hello, but deal to localhost:9090
+  httpoverrpc get --hostname example.com --dialAddress localhost:9090 9090 /hello
 
   Note:
   1. The prefix / in request_uri is always needed, even there is nothing to put
@@ -252,6 +257,7 @@ func (g *getCmd) SetFlags(f *flag.FlagSet) {
 	f.StringVar(&g.body, "body", "", "Body to send in request")
 	f.BoolVar(&g.showResponseHeaders, "show-response-headers", false, "If true, print response code and headers")
 	f.BoolVar(&g.insecureSkipVerify, "insecure-skip-tls-verify", false, "If true, skip TLS cert verification")
+	f.StringVar(&g.dialAddress, "dial-address", "", "host:port to dial to. If not provided would dial to original host and port")
 }
 
 func (g *getCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...interface{}) subcommands.ExitStatus {
@@ -270,6 +276,14 @@ func (g *getCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...interface
 		return subcommands.ExitUsageError
 	}
 
+	if g.dialAddress != "" {
+		_, _, err := validator.ParseHostAndPort(g.dialAddress)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Unable to parse dial address \"%q\": %v\n", g.dialAddress, err)
+			return subcommands.ExitUsageError
+		}
+	}
+
 	var reqHeaders []*pb.Header
 	for _, v := range g.headers {
 		split := strings.SplitN(v, ":", 2)
@@ -280,7 +294,12 @@ func (g *getCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...interface
 		reqHeaders = append(reqHeaders, &pb.Header{Key: split[0], Values: []string{strings.TrimSpace(split[1])}})
 	}
 
-	proxy := pb.NewHTTPOverRPCClientProxy(state.Conn)
+	var dialConfig *pb.DialConfig = nil
+	if g.dialAddress != "" {
+		dialConfig = &pb.DialConfig{
+			DialAddress: &g.dialAddress,
+		}
+	}
 
 	req := &pb.HostHTTPRequest{
 		Request: &pb.HTTPRequest{
@@ -295,8 +314,10 @@ func (g *getCmd) Execute(ctx context.Context, f *flag.FlagSet, args ...interface
 		Tlsconfig: &pb.TLSConfig{
 			InsecureSkipVerify: g.insecureSkipVerify,
 		},
+		Dialconfig: dialConfig,
 	}
 
+	proxy := pb.NewHTTPOverRPCClientProxy(state.Conn)
 	resp, err := proxy.HostOneMany(ctx, req)
 	retCode := subcommands.ExitSuccess
 	if err != nil {

diff --git a/services/httpoverrpc/client/utils.go b/services/httpoverrpc/client/utils.go
@@ -38,13 +38,16 @@ var (
 	errInvalidURLMissingHost = fmt.Errorf("no host in the request URL")
 )
 
+// HTTPTransporter implementation of [http.RoundTripper], which proxy HTTP requests over RPC to target host to send request from it
 type HTTPTransporter struct {
 	conn               *proxy.Conn
 	insecureSkipVerify bool
+	dialConfigFactory  func(req http.Request) *pb.DialConfig
 }
 
 type httpTransporterOptions struct {
 	insecureSkipVerify bool
+	dialConfigFactory  func(req http.Request) *pb.DialConfig
 }
 
 type Option interface {
@@ -63,7 +66,13 @@ func WithInsecureSkipVerify(insecureSkipVerify bool) Option {
 	})
 }
 
-func NewHTTPTransporter(conn *proxy.Conn, opts ...Option) *HTTPTransporter {
+func WithCustomDialConfig(dialConfigFactory func(req http.Request) *pb.DialConfig) Option {
+	return optionFunc(func(o *httpTransporterOptions) {
+		o.dialConfigFactory = dialConfigFactory
+	})
+}
+
+func NewHTTPTransporter(conn *proxy.Conn, opts ...Option) http.RoundTripper {
 	options := &httpTransporterOptions{
 		insecureSkipVerify: false,
 	}
@@ -74,6 +83,7 @@ func NewHTTPTransporter(conn *proxy.Conn, opts ...Option) *HTTPTransporter {
 	return &HTTPTransporter{
 		conn:               conn,
 		insecureSkipVerify: options.insecureSkipVerify,
+		dialConfigFactory:  options.dialConfigFactory,
 	}
 }
 
@@ -152,6 +162,11 @@ func (c *HTTPTransporter) RoundTrip(req *http.Request) (*http.Response, error) {
 			return nil, err
 		}
 	}
+
+	var dialConfig *pb.DialConfig = nil
+	if c.dialConfigFactory != nil {
+		dialConfig = c.dialConfigFactory(*req)
+	}
 	reqPb := &pb.HostHTTPRequest{
 		Request: &pb.HTTPRequest{
 			RequestUri: req.URL.RequestURI(),
@@ -164,6 +179,7 @@ func (c *HTTPTransporter) RoundTrip(req *http.Request) (*http.Response, error) {
 		Tlsconfig: &pb.TLSConfig{
 			InsecureSkipVerify: c.insecureSkipVerify,
 		},
+		Dialconfig: dialConfig,
 	}
 
 	port, errPort := getPort(req, reqPb.Protocol)

diff --git a/services/httpoverrpc/httpoverrpc.pb.go b/services/httpoverrpc/httpoverrpc.pb.go
diff --git a/services/httpoverrpc/httpoverrpc.proto b/services/httpoverrpc/httpoverrpc.proto
@@ -39,7 +39,7 @@ message HostHTTPRequest {
   // TLS Config for the request
   TLSConfig tlsconfig = 5;
   // Dial Config for request, if not provided uses default dialer configuration
-  DialConfig dialconfig = 6;
+  optional DialConfig dialconfig = 6;
 }
 
 message TLSConfig {
@@ -49,7 +49,7 @@ message TLSConfig {
 
 message DialConfig {
   // address to dial to, if not provided uses original one
-  string dialAddress = 1;
+  optional string dialAddress = 1;
 }
 
 message Header {

diff --git a/services/httpoverrpc/server/server.go b/services/httpoverrpc/server/server.go
@@ -88,7 +88,7 @@ func (s *server) Host(ctx context.Context, req *pb.HostHTTPRequest) (*pb.HTTPRep
 			}
 		}
 
-		if req.Dialconfig != nil {
+		if req.GetDialconfig() != nil {
 			transport.DialContext = func(ctx context.Context, network, addr string) (net.Conn, error) {
 				dailAddress := addr
 				if req.Dialconfig.GetDialAddress() != "" {

diff --git a/services/httpoverrpc/server/server_test.go b/services/httpoverrpc/server/server_test.go
@@ -325,7 +325,7 @@ func TestServer(t *testing.T) {
 			Hostname: targetHost,
 			Protocol: "http",
 			Dialconfig: &httpoverrpc.DialConfig{
-				DialAddress: addressToDial,
+				DialAddress: &addressToDial,
 			},
 		})
 		if err != nil {