Add SourceAddr support (#82)

* Add RemoteAddr support

* add port to example

* use SourceAddr

* add tests

Author: zetaab

api/handler/handler.go

@@ -161,6 +161,9 @@ type Host interface {
 	// FuncRemoveHeader with HeaderKindResponseTrailers. This panics if
 	// FeatureTrailers is not supported.
 	RemoveResponseTrailer(ctx context.Context, name string)
+
+	// GetSourceAddr supports the WebAssembly function export FuncGetSourceAddr.
+	GetSourceAddr(ctx context.Context) string
 }
 
 // eofReader is safer than reading from os.DevNull as it can never overrun
@@ -206,3 +209,4 @@ func (UnimplementedHost) GetResponseTrailerValues(context.Context, string) (valu
 func (UnimplementedHost) SetResponseTrailerValue(context.Context, string, string)            {}
 func (UnimplementedHost) AddResponseTrailerValue(context.Context, string, string)            {}
 func (UnimplementedHost) RemoveResponseTrailer(context.Context, string)                      {}
+func (UnimplementedHost) GetSourceAddr(context.Context) string                               { return "1.1.1.1:12345" }

api/handler/wasm.go

@@ -316,4 +316,10 @@ const (
 	//
 	// TODO: document on http-wasm-abi
 	FuncSetStatusCode = "set_status_code"
+
+	// FuncGetSourceAddr writes the SourceAddr to memory if it isn't larger than BufLimit.
+	// The result is its length in bytes. Ex. "1.1.1.1:12345" or "[fe80::101e:2bdf:8bfb:b97e]:12345"
+	//
+	// TODO: document on http-wasm-abi
+	FuncGetSourceAddr = "get_source_addr"
 )

handler/middleware.go

@@ -565,6 +565,17 @@ func (m *middleware) writeBody(ctx context.Context, mod wazeroapi.Module, params
 	writeBody(mod, buf, bufLen, w)
 }
 
+// getSourceAddr implements the WebAssembly host function handler.FuncGetSourceAddr.
+func (m *middleware) getSourceAddr(ctx context.Context, mod wazeroapi.Module, stack []uint64) {
+	buf := uint32(stack[0])
+	bufLimit := handler.BufLimit(stack[1])
+
+	method := m.host.GetSourceAddr(ctx)
+	methodLen := writeStringIfUnderLimit(mod.Memory(), buf, bufLimit, method)
+
+	stack[0] = uint64(methodLen)
+}
+
 func writeBody(mod wazeroapi.Module, buf, bufLen uint32, w io.Writer) {
 	// buf_len 0 means to overwrite with nothing
 	var b []byte
@@ -694,6 +705,9 @@ func (m *middleware) instantiateHost(ctx context.Context) (wazeroapi.Module, err
 		WithGoModuleFunction(wazeroapi.GoModuleFunc(m.writeBody), []wazeroapi.ValueType{i32, i32, i32}, []wazeroapi.ValueType{}).
 		WithParameterNames("kind", "body", "body_len").Export(handler.FuncWriteBody).
 		NewFunctionBuilder().
+		WithGoModuleFunction(wazeroapi.GoModuleFunc(m.getSourceAddr), []wazeroapi.ValueType{i32, i32}, []wazeroapi.ValueType{i32}).
+		WithParameterNames("buf", "buf_limit").Export(handler.FuncGetSourceAddr).
+		NewFunctionBuilder().
 		WithGoFunction(wazeroapi.GoFunc(m.getStatusCode), []wazeroapi.ValueType{}, []wazeroapi.ValueType{i32}).
 		WithParameterNames().Export(handler.FuncGetStatusCode).
 		NewFunctionBuilder().

handler/nethttp/host.go

@@ -346,3 +346,9 @@ func addTrailer(header http.Header, name string, value string) {
 func removeTrailer(header http.Header, name string) {
 	header.Del(http.TrailerPrefix + name)
 }
+
+// GetSourceAddr implements the same method as documented on handler.Host.
+func (host) GetSourceAddr(ctx context.Context) string {
+	r := requestStateFromContext(ctx).r
+	return r.RemoteAddr
+}

handler/nethttp/host_test.go

@@ -17,6 +17,7 @@ func Test_host(t *testing.T) {
 	newCtx := func(features handler.Features) (context.Context, handler.Features) {
 		// The below configuration supports all features.
 		r, _ := http.NewRequest("GET", "", bytes.NewReader(nil))
+		r.RemoteAddr = "1.2.3.4:12345"
 		w := &bufferingResponseWriter{delegate: &httptest.ResponseRecorder{HeaderMap: map[string][]string{}}}
 		return context.WithValue(testCtx, requestStateKey{}, &requestState{r: r, w: w}), features
 	}

tck/guest/go.mod

@@ -2,4 +2,4 @@ module github.com/anuraaga/http-wasm-tck/guest
 
 go 1.19
 
-require github.com/http-wasm/http-wasm-guest-tinygo v0.1.1
+require github.com/http-wasm/http-wasm-guest-tinygo v0.3.1-0.20231031134125-487a6e2eec5e

tck/guest/go.sum

@@ -1,2 +1,2 @@
-github.com/http-wasm/http-wasm-guest-tinygo v0.1.1 h1:7L+MhMNDVsUAqmElG64JEZ0n1yGCKTx0w01N1b08Xhc=
-github.com/http-wasm/http-wasm-guest-tinygo v0.1.1/go.mod h1:roTs1mkyGDe1CUzrL8JUXSbPNYUHnnWKMCG6epmRAZY=
+github.com/http-wasm/http-wasm-guest-tinygo v0.3.1-0.20231031134125-487a6e2eec5e h1:mUEuIuH+XAtp5tkJPpwN5ZAtgvt64tYaYsk/KoK42lQ=
+github.com/http-wasm/http-wasm-guest-tinygo v0.3.1-0.20231031134125-487a6e2eec5e/go.mod h1:zcKr7h/t5ha2ZWIMwV4iOqhfC/qno/tNPYgybVkn/MQ=

tck/guest/main.go

@@ -104,6 +104,8 @@ func (h *handler) handleRequest(req api.Request, resp api.Response) (next bool,
 		next, reqCtx = h.testReadBody(req, resp, strings.Repeat("a", 4096))
 	case "read_body/request/xlarge":
 		next, reqCtx = h.testReadBody(req, resp, strings.Repeat("a", 5000))
+	case "get_source_addr":
+		next, reqCtx = h.testGetSourceAddr(req, resp, "127.0.0.1")
 	default:
 		fail(resp, "unknown x-httpwasm-test-id")
 	}
@@ -214,6 +216,24 @@ func (h *handler) testReadBody(req api.Request, resp api.Response, expectedBody
 	return true, 0
 }
 
+func (h *handler) testGetSourceAddr(req api.Request, resp api.Response, expectedAddr string) (next bool, reqCtx uint32) {
+	addr := req.GetSourceAddr()
+	raw := strings.Split(addr, ":")
+	if len(raw) != 2 {
+		fail(resp, fmt.Sprintf("get_source_addr: unknown colon count %s", req.GetSourceAddr()))
+		return
+	}
+	if raw[0] != expectedAddr {
+		fail(resp, fmt.Sprintf("get_source_addr: want %s, have %s", expectedAddr, req.GetSourceAddr()))
+		return
+	}
+	if len(raw[1]) <= 0 || len(raw[1]) > 5 {
+		fail(resp, fmt.Sprintf("get_source_addr: could not find port number '%s' from %s", raw[1], req.GetSourceAddr()))
+		return
+	}
+	return true, 0
+}
+
 func fail(resp api.Response, msg string) {
 	resp.SetStatusCode(500)
 	resp.Headers().Set("x-httpwasm-tck-failed", msg)

tck/run.go

@@ -53,6 +53,7 @@ func Run(t *testing.T, client *http.Client, url string) {
 	r.testAddHeaderValueRequest()
 	r.testRemoveHeaderRequest()
 	r.testReadBodyRequest()
+	r.testGetSourceAddr()
 }
 
 type testRunner struct {
@@ -493,6 +494,24 @@ func (r *testRunner) testRemoveHeaderRequest() {
 	}
 }
 
+func (r *testRunner) testGetSourceAddr() {
+	hostFn := handler.FuncGetSourceAddr
+
+	r.t.Run(hostFn, func(t *testing.T) {
+		req, err := http.NewRequest("GET", r.url, nil)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		req.Header.Set("x-httpwasm-tck-testid", hostFn)
+		resp, err := r.client.Do(req)
+		if err != nil {
+			t.Error(err)
+		}
+		checkResponse(t, resp)
+	})
+}
+
 func checkResponse(t *testing.T, resp *http.Response) string {
 	t.Helper()