Feature: Golang Http Tcp Bridge

.github/dependabot.yml

@@ -179,3 +179,73 @@ updates:
   schedule:
     interval: daily
     time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/buffered"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/header_op"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/local_reply"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/panic"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/property"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/self_half_close"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"
+
+- package-ecosystem: "gomod"
+  directory: "/contrib/golang/upstreams/http/tcp/test/test_data/streaming"
+  groups:
+    contrib-golang:
+      patterns:
+      - "*"
+  schedule:
+    interval: daily
+    time: "06:00"

api/BUILD

@@ -97,6 +97,7 @@ proto_library(
         "//contrib/envoy/extensions/private_key_providers/qat/v3alpha:pkg",
         "//contrib/envoy/extensions/regex_engines/hyperscan/v3alpha:pkg",
         "//contrib/envoy/extensions/router/cluster_specifier/golang/v3alpha:pkg",
+        "//contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha:pkg",
         "//contrib/envoy/extensions/vcl/v3alpha:pkg",
         "//envoy/admin/v3:pkg",
         "//envoy/config/accesslog/v3:pkg",

api/contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha/BUILD

@@ -0,0 +1,12 @@
+# DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py.
+
+load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package")
+
+licenses(["notice"])  # Apache 2
+
+api_proto_package(
+    deps = [
+        "@com_github_cncf_xds//udpa/annotations:pkg",
+        "@com_github_cncf_xds//xds/annotations/v3:pkg",
+    ],
+)

api/contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha/golang.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+package envoy.extensions.upstreams.http.tcp.golang.v3alpha;
+
+import "google/protobuf/any.proto";
+
+import "xds/annotations/v3/status.proto";
+
+import "udpa/annotations/status.proto";
+import "validate/validate.proto";
+
+option java_package = "io.envoyproxy.envoy.extensions.upstreams.http.tcp.golang.v3alpha";
+option java_outer_classname = "GolangProto";
+option java_multiple_files = true;
+option go_package = "github.com/envoyproxy/go-control-plane/contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha";
+option (udpa.annotations.file_status).package_version_status = ACTIVE;
+option (xds.annotations.v3.file_status).work_in_progress = true;
+
+// [#protodoc-title: Golang Http Tcp Bridge]
+//
+// This bridge enables an Http client to connect to a TCP server via a Golang plugin, facilitating Protocol Convert from HTTP to any RPC protocol in Envoy.
+//
+// For an overview of the Golang Http bridge please see the :ref:`configuration reference documentation <config_http_tcp_bridge_golang>`.
+// [#extension: envoy.upstreams.http.tcp.golang]
+message Config {
+  // Globally unique ID for a dynamic library file.
+  string library_id = 1 [(validate.rules).string = {min_len: 1}];
+
+  // Path to a dynamic library implementing the
+  // :repo:`HttpTcpBridge API <contrib/golang/common/go/api.HttpTcpBridge>`
+  // interface.
+  string library_path = 2 [(validate.rules).string = {min_len: 1}];
+
+  // Globally unique name of the Go plugin.
+  //
+  // This name **must** be consistent with the name registered in ``tcp::RegisterHttpTcpBridgeFactoryAndConfigParser``
+  //
+  string plugin_name = 3 [(validate.rules).string = {min_len: 1}];
+
+  // Configuration for the Go plugin.
+  //
+  // .. note::
+  //     This configuration is only parsed in the go plugin, and is therefore not validated
+  //     by Envoy.
+  //
+  //     See the :repo:`HttpTcpBridge API <contrib/golang/common/go/api/filter.go>`
+  //     for more information about how the plugin's configuration data can be accessed.
+  //
+  google.protobuf.Any plugin_config = 4;
+}

api/versioning/BUILD

@@ -35,6 +35,7 @@ proto_library(
         "//contrib/envoy/extensions/private_key_providers/qat/v3alpha:pkg",
         "//contrib/envoy/extensions/regex_engines/hyperscan/v3alpha:pkg",
         "//contrib/envoy/extensions/router/cluster_specifier/golang/v3alpha:pkg",
+        "//contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha:pkg",
         "//contrib/envoy/extensions/vcl/v3alpha:pkg",
         "//envoy/admin/v3:pkg",
         "//envoy/config/accesslog/v3:pkg",

contrib/contrib_build_config.bzl

@@ -83,4 +83,10 @@ CONTRIB_EXTENSIONS = {
     #
 
     "envoy.router.cluster_specifier_plugin.golang":             "//contrib/golang/router/cluster_specifier/source:config",
+
+    #
+    # http tcp upstream plugin
+    #
+
+    "envoy.upstreams.http.tcp.golang":                          "//contrib/golang/upstreams/http/tcp/source:config",
 }

contrib/extensions_metadata.yaml

@@ -130,3 +130,8 @@ envoy.router.cluster_specifier_plugin.golang:
   - envoy.router.cluster_specifier_plugin
   security_posture: requires_trusted_downstream_and_upstream
   status: alpha
+envoy.upstreams.http.tcp.golang:
+  categories:
+  - envoy.upstreams
+  security_posture: requires_trusted_downstream_and_upstream
+  status: alpha

contrib/golang/common/dso/dso.cc

@@ -242,5 +242,66 @@ void NetworkFilterDsoImpl::envoyGoFilterOnSemaDec(void* w) {
   envoy_go_filter_on_sema_dec_(w);
 }
 
+HttpTcpBridgeDsoImpl::HttpTcpBridgeDsoImpl(const std::string dso_name)
+    : HttpTcpBridgeDso(dso_name) {
+  loaded_ &= dlsymInternal<decltype(envoy_go_http_tcp_bridge_on_config_)>(
+      envoy_go_http_tcp_bridge_on_config_, handler_, dso_name, "envoyGoHttpTcpBridgeOnConfig");
+  loaded_ &= dlsymInternal<decltype(envoy_go_http_tcp_bridge_destroy_plugin_config_)>(
+      envoy_go_http_tcp_bridge_destroy_plugin_config_, handler_, dso_name,
+      "envoyGoHttpTcpBridgeDestroyPluginConfig");
+  loaded_ &= dlsymInternal<decltype(envoy_go_http_tcp_bridge_on_encode_header_)>(
+      envoy_go_http_tcp_bridge_on_encode_header_, handler_, dso_name,
+      "envoyGoHttpTcpBridgeOnEncodeHeader");
+  loaded_ &= dlsymInternal<decltype(envoy_go_http_tcp_bridge_on_encode_data_)>(
+      envoy_go_http_tcp_bridge_on_encode_data_, handler_, dso_name,
+      "envoyGoHttpTcpBridgeOnEncodeData");
+  loaded_ &= dlsymInternal<decltype(envoy_go_http_tcp_bridge_on_upstream_data_)>(
+      envoy_go_http_tcp_bridge_on_upstream_data_, handler_, dso_name,
+      "envoyGoHttpTcpBridgeOnUpstreamData");
+  loaded_ &= dlsymInternal<decltype(envoy_go_http_tcp_bridge_on_destroy_)>(
+      envoy_go_http_tcp_bridge_on_destroy_, handler_, dso_name, "envoyGoHttpTcpBridgeOnDestroy");
+}
+
+GoUint64 HttpTcpBridgeDsoImpl::envoyGoHttpTcpBridgeOnConfig(httpConfig* p0) {
+  ASSERT(envoy_go_http_tcp_bridge_on_config_ != nullptr);
+  return envoy_go_http_tcp_bridge_on_config_(p0);
+}
+
+void HttpTcpBridgeDsoImpl::envoyGoHttpTcpBridgeDestroyPluginConfig(GoUint64 p0) {
+  ASSERT(envoy_go_http_tcp_bridge_destroy_plugin_config_ != nullptr);
+  return envoy_go_http_tcp_bridge_destroy_plugin_config_(p0);
+}
+
+GoUint64
+HttpTcpBridgeDsoImpl::envoyGoHttpTcpBridgeOnEncodeHeader(processState* state, GoUint64 end_stream,
+                                                         GoUint64 header_num, GoUint64 header_bytes,
+                                                         GoUint64 buf_ptr, GoUint64 buf_len) {
+  ASSERT(envoy_go_http_tcp_bridge_on_encode_header_ != nullptr);
+  return envoy_go_http_tcp_bridge_on_encode_header_(state, end_stream, header_num, header_bytes,
+                                                    buf_ptr, buf_len);
+}
+
+GoUint64 HttpTcpBridgeDsoImpl::envoyGoHttpTcpBridgeOnEncodeData(processState* state,
+                                                                GoUint64 end_stream,
+                                                                GoUint64 buf_ptr,
+                                                                GoUint64 buf_len) {
+  ASSERT(envoy_go_http_tcp_bridge_on_encode_data_ != nullptr);
+  return envoy_go_http_tcp_bridge_on_encode_data_(state, end_stream, buf_ptr, buf_len);
+}
+
+GoUint64
+HttpTcpBridgeDsoImpl::envoyGoHttpTcpBridgeOnUpstreamData(processState* state, GoUint64 end_stream,
+                                                         GoUint64 header_num, GoUint64 header_bytes,
+                                                         GoUint64 buf_ptr, GoUint64 buf_len) {
+  ASSERT(envoy_go_http_tcp_bridge_on_upstream_data_ != nullptr);
+  return envoy_go_http_tcp_bridge_on_upstream_data_(state, end_stream, header_num, header_bytes,
+                                                    buf_ptr, buf_len);
+}
+
+void HttpTcpBridgeDsoImpl::envoyGoHttpTcpBridgeOnDestroy(httpRequest* p0) {
+  ASSERT(envoy_go_http_tcp_bridge_on_destroy_ != nullptr);
+  envoy_go_http_tcp_bridge_on_destroy_(p0);
+}
+
 } // namespace Dso
 } // namespace Envoy

contrib/golang/common/dso/dso.h

@@ -201,6 +201,76 @@ class NetworkFilterDsoImpl : public NetworkFilterDso {
 
 using NetworkFilterDsoPtr = std::shared_ptr<NetworkFilterDso>;
 
+class HttpTcpBridgeDso : public Dso {
+public:
+  HttpTcpBridgeDso() = default;
+  HttpTcpBridgeDso(const std::string dso_name) : Dso(dso_name){};
+  ~HttpTcpBridgeDso() override = default;
+
+  virtual GoUint64 envoyGoHttpTcpBridgeOnConfig(httpConfig* p0) PURE;
+
+  virtual void envoyGoHttpTcpBridgeDestroyPluginConfig(GoUint64 p0) PURE;
+
+  virtual GoUint64 envoyGoHttpTcpBridgeOnEncodeHeader(processState* state, GoUint64 end_stream,
+                                                      GoUint64 header_num, GoUint64 header_bytes,
+                                                      GoUint64 buf_ptr, GoUint64 buf_len) PURE;
+
+  virtual GoUint64 envoyGoHttpTcpBridgeOnEncodeData(processState* state, GoUint64 end_stream,
+                                                    GoUint64 buf_ptr, GoUint64 buf_len) PURE;
+
+  virtual GoUint64 envoyGoHttpTcpBridgeOnUpstreamData(processState* state, GoUint64 end_stream,
+                                                      GoUint64 header_num, GoUint64 header_bytes,
+                                                      GoUint64 buf_ptr, GoUint64 buf_len) PURE;
+
+  virtual void envoyGoHttpTcpBridgeOnDestroy(httpRequest* p0) PURE;
+};
+
+class HttpTcpBridgeDsoImpl : public HttpTcpBridgeDso {
+public:
+  HttpTcpBridgeDsoImpl(const std::string dso_name);
+  ~HttpTcpBridgeDsoImpl() override = default;
+
+  GoUint64 envoyGoHttpTcpBridgeOnConfig(httpConfig* p0) override;
+
+  void envoyGoHttpTcpBridgeDestroyPluginConfig(GoUint64 p0) override;
+
+  GoUint64 envoyGoHttpTcpBridgeOnEncodeHeader(processState* state, GoUint64 end_stream,
+                                              GoUint64 header_num, GoUint64 header_bytes,
+                                              GoUint64 buf_ptr, GoUint64 buf_len) override;
+
+  GoUint64 envoyGoHttpTcpBridgeOnEncodeData(processState* state, GoUint64 end_stream,
+                                            GoUint64 buf_ptr, GoUint64 buf_len) override;
+
+  GoUint64 envoyGoHttpTcpBridgeOnUpstreamData(processState* state, GoUint64 end_stream,
+                                              GoUint64 header_num, GoUint64 header_bytes,
+                                              GoUint64 buf_ptr, GoUint64 buf_len) override;
+
+  void envoyGoHttpTcpBridgeOnDestroy(httpRequest* p0) override;
+
+private:
+  GoUint64 (*envoy_go_http_tcp_bridge_on_config_)(httpConfig* p0) = {nullptr};
+
+  void (*envoy_go_http_tcp_bridge_destroy_plugin_config_)(GoUint64 p0) = {nullptr};
+
+  GoUint64 (*envoy_go_http_tcp_bridge_on_encode_header_)(processState* p0, GoUint64 p1, GoUint64 p2,
+                                                         GoUint64 p3, GoUint64 buf_ptr,
+                                                         GoUint64 buf_len) = {nullptr};
+
+  GoUint64 (*envoy_go_http_tcp_bridge_on_encode_data_)(processState* state, GoUint64 end_stream,
+                                                       GoUint64 buf_ptr,
+                                                       GoUint64 buf_len) = {nullptr};
+
+  GoUint64 (*envoy_go_http_tcp_bridge_on_upstream_data_)(processState* state, GoUint64 end_stream,
+                                                         GoUint64 header_size,
+                                                         GoUint64 header_byte_size,
+                                                         GoUint64 buf_ptr,
+                                                         GoUint64 buf_len) = {nullptr};
+
+  void (*envoy_go_http_tcp_bridge_on_destroy_)(httpRequest* p0) = {nullptr};
+};
+
+using HttpTcpBridgeDsoPtr = std::shared_ptr<HttpTcpBridgeDso>;
+
 /*
  * We do not unload a dynamic library once it is loaded. This is because
  * Go shared library could not be unload by dlclose yet, see:

contrib/golang/common/dso/libgolang.h

@@ -193,6 +193,36 @@ extern GoUint64 envoyGoFilterOnUpstreamData(void* f, GoUint64 data_size, GoUint6
 // github.com/envoyproxy/envoy/contrib/golang/filters/network/source/go/pkg/network.envoyGoFilterOnUpstreamEvent
 extern void envoyGoFilterOnUpstreamEvent(void* f, GoInt event);
 
+// go:linkname envoyGoHttpTcpBridgeOnConfig
+// github.com/envoyproxy/envoy/contrib/golang/filters/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp.envoyGoHttpTcpBridgeOnConfig
+extern GoUint64 envoyGoHttpTcpBridgeOnConfig(GoUint64 library_id_ptr, GoUint64 library_id_len,
+                                             GoUint64 config_ptr, GoUint64 config_len);
+
+// go:linkname envoyGoHttpTcpBridgeDestroyPluginConfig
+// github.com/envoyproxy/envoy/contrib/golang/filters/http/source/go/pkg/http.envoyGoHttpTcpBridgeDestroyPluginConfig
+extern void envoyGoHttpTcpBridgeDestroyPluginConfig(GoUint64 id);
+
+// go:linkname envoyGoHttpTcpBridgeOnEncodeHeader
+// github.com/envoyproxy/envoy/contrib/golang/filters/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp.envoyGoHttpTcpBridgeOnEncodeHeader
+extern GoUint64 envoyGoHttpTcpBridgeOnEncodeHeader(processState* r, GoUint64 end_stream,
+                                                   GoUint64 header_num, GoUint64 header_bytes,
+                                                   GoUint64 buf_ptr, GoUint64 buf_len);
+
+// go:linkname envoyGoHttpTcpBridgeOnEncodeData
+// github.com/envoyproxy/envoy/contrib/golang/filters/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp.envoyGoHttpTcpBridgeOnEncodeData
+extern GoUint64 envoyGoHttpTcpBridgeOnEncodeData(processState* state, GoUint64 end_stream,
+                                                 GoUint64 buf_ptr, GoUint64 buf_len);
+
+// go:linkname envoyGoHttpTcpBridgeOnUpstreamData
+// github.com/envoyproxy/envoy/contrib/golang/filters/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp.envoyGoHttpTcpBridgeOnUpstreamData
+extern GoUint64 envoyGoHttpTcpBridgeOnUpstreamData(processState* state, GoUint64 end_stream,
+                                                   GoUint64 header_num, GoUint64 header_bytes,
+                                                   GoUint64 buf_ptr, GoUint64 buf_len);
+
+// go:linkname envoyGoHttpTcpBridgeOnDestroy
+// github.com/envoyproxy/envoy/contrib/golang/filters/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp.envoyGoHttpTcpBridgeOnDestroy
+extern void envoyGoHttpTcpBridgeOnDestroy(httpRequest* r);
+
 #ifdef __cplusplus
 }
 #endif

contrib/golang/common/go/api/api.h

@@ -147,6 +147,19 @@ CAPIStatus envoyGoFilterSetFilterState(void* wrapper, void* key, void* value, in
                                        int life_span, int stream_sharing);
 CAPIStatus envoyGoFilterGetFilterState(void* wrapper, void* key, void* value);
 
+// tcp upstream
+CAPIStatus envoyGoHttpTcpBridgeCopyHeaders(void* s, void* strs, void* buf);
+CAPIStatus envoyGoHttpTcpBridgeSetRespHeader(void* s, void* key_data, int key_len, void* value_data,
+                                             int value_len, headerAction action);
+CAPIStatus envoyGoHttpTcpBridgeRemoveRespHeader(void* s, void* key_data, int key_len);
+CAPIStatus envoyGoHttpTcpBridgeGetBuffer(void* s, uint64_t buffer, void* value);
+CAPIStatus envoyGoHttpTcpBridgeDrainBuffer(void* s, uint64_t buffer, uint64_t length);
+CAPIStatus envoyGoHttpTcpBridgeSetBufferHelper(void* s, uint64_t buffer, void* data, int length,
+                                               bufferAction action);
+CAPIStatus envoyGoHttpTcpBridgeGetStringValue(void* r, int id, uint64_t* value_data,
+                                              int* value_len);
+CAPIStatus envoyGoHttpTcpBridgeSetSelfHalfCloseForUpstreamConn(void* r, int enabled);
+
 #ifdef __cplusplus
 } // extern "C"
 #endif

contrib/golang/common/go/api/capi.go

@@ -99,6 +99,22 @@ type NetworkCAPI interface {
 	UpstreamInfo(f unsafe.Pointer, infoType int) string
 }
 
+type TcpUpstreamCAPI interface {
+	// Header related
+	CopyHeaders(s unsafe.Pointer, num uint64, bytes uint64) map[string][]string
+	SetRespHeader(s unsafe.Pointer, key string, value string, add bool)
+	RemoveRespHeader(s unsafe.Pointer, key string)
+	// Buffer related
+	GetBuffer(s unsafe.Pointer, bufferPtr uint64, length uint64) []byte
+	DrainBuffer(s unsafe.Pointer, bufferPtr uint64, length uint64)
+	SetBufferHelper(s unsafe.Pointer, bufferPtr uint64, value string, action BufferAction)
+	SetBytesBufferHelper(s unsafe.Pointer, bufferPtr uint64, value []byte, action BufferAction)
+	// Get the specified value by key
+	GetStringValue(r unsafe.Pointer, id int) (string, bool)
+
+	SetSelfHalfCloseForUpstreamConn(r unsafe.Pointer, enabled int)
+}
+
 type CommonCAPI interface {
 	Log(level LogType, message string)
 	LogLevel() LogType