WebAssembly 助力云原生:APISIX 如何借助 Wasm 插件实现扩展功能?

更新时间 3/28/2023

什么是 Wasm

Wasm 是 WebAssembly 的缩写。WebAssembly/Wasm 是一个基于堆栈的虚拟机设计的指令格式。 在 Wasm 未出现之前,浏览器中只能支持运行 Javascript 语言。当 Wasm 出现之后,使得高级语言例如 C/C++/Golang 能够在浏览器中运行。当前,主流的浏览器包括 Chrome、Firefox、Safari 等浏览器都已完成对 Wasm 的支持。并且得益于 WASI 项目的推进,服务端也已经能够支持运行 Wasm 指令。 如今在网关侧,Apache APISIX 也已完成对 Wasm 的支持,开发者可以通过高级语言 C/C++/Go/Rust 并按照 proxy-wasm 规范来完成 Wasm 插件的开发。

wasm

为什么 APISIX 要支持 Wasm 插件

相比较原生的 Lua 插件,Wasm 插件存在如下优势:

  • 可扩展性:APISIX 通过支持 Wasm,我们可以结合 proxy-wasm 提供的 SDK,使用 C++/Golang/Rust 等语言进行插件开发。由于高级语言往往拥有更加丰富的生态,所以我们可以依托于这些生态来实现支持更多功能丰富的插件。

  • 安全性:由于 APISIX 和 Wasm 之前的调用依托于 proxy-wasm 提供的 ABI(二进制应用接口),这部分的访问调用更为安全。Wasm 插件只允许对请求进行特定的修改。另外,由于 Wasm 插件运行在特定的 VM 中,所以即使插件运行出现崩溃也不会影响 APISIX 主进程的运行。

APISIX 如何支持 WASM

了解完 Wasm,现在我们将从自顶向下的角度来看 APISIX 是如何支持 Wasm 插件功能的。

apisix-wasm

APISIX Wasm 插件

在 APISIX 中,我们可以使用高级语言 C/C++/Go/Rust 来按照 proxy-wasm 规范以及对应的 SDK 来编写插件。

proxy-wasm 是 Envoy 推出的在 L4/L7 代理之间的 ABI 的规范与标准。

在该规范中定义了包含内存管理、四层代理、七层代理扩展等 ABI。 例如在七层代理中,proxy-wasm 规范定义了proxy_on_http_request_headers,proxy_on_http_request_body,proxy_on_http_request_trailers,proxy_on_http_response_headers 等 ABI,使得模块能够在各个阶段对请求内容进行获取与修改。

例如,我们使用 Golang 结合 proxy-wasm-go-sdk, 编写如下插件:

proxy-wasm-go-sdk 正是上述 proxy-wasm 规范的 SDK,它帮助开发者更好的使用 Golang 编写 proxy-wasm 插件。

不过需要注意的是,由于原生 Golang 在支持 WASI 时存在一些问题,因此该 SDK 基于 TinyGo 实现,更多内容可以点击进行查看。

该插件的主要功能用于将 HTTP 修改请求的响应状态码与响应体,引用自 APISIX 链接

1...
2func (ctx *pluginContext) OnPluginStart(pluginConfigurationSize int) types.OnPluginStartStatus {
3        data, err := proxywasm.GetPluginConfiguration()
4        if err != nil {
5                proxywasm.LogErrorf("error reading plugin configuration: %v", err)
6                return types.OnPluginStartStatusFailed
7        }
8
9        var p fastjson.Parser
10        v, err := p.ParseBytes(data)
11        if err != nil {
12                proxywasm.LogErrorf("error decoding plugin configuration: %v", err)
13                return types.OnPluginStartStatusFailed
14        }
15        ctx.Body = v.GetStringBytes("body")
16        ctx.HttpStatus = uint32(v.GetUint("http_status"))
17        if v.Exists("percentage") {
18                ctx.Percentage = v.GetInt("percentage")
19        } else {
20                ctx.Percentage = 100
21        }
22
23        // schema check
24        if ctx.HttpStatus < 200 {
25                proxywasm.LogError("bad http_status")
26                return types.OnPluginStartStatusFailed
27        }
28        if ctx.Percentage < 0 || ctx.Percentage > 100 {
29                proxywasm.LogError("bad percentage")
30                return types.OnPluginStartStatusFailed
31        }
32
33        return types.OnPluginStartStatusOK
34}
35
36func (ctx *httpLifecycle) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
37        plugin := ctx.parent
38        if !sampleHit(plugin.Percentage) {
39                return types.ActionContinue
40        }
41
42        err := proxywasm.SendHttpResponse(plugin.HttpStatus, nil, plugin.Body, -1)
43        if err != nil {
44                proxywasm.LogErrorf("failed to send local response: %v", err)
45                return types.ActionContinue
46        }
47        return types.ActionPause
48}
49...

之后,我们通过 tiny-go 将上述的 Golang 代码编译生成 .wasm 文件

1tinygo build -o wasm_fault_injection.go.wasm -scheduler=none -target=wasi ./main.go

完成编译之后,我们得到了 fault_injection.go.wasm 文件

如果对 wasm 文件内容感兴趣的话,我们可以使用 wasm-tool 工具来查看该 wasm 文件的具体内容。

wasm-tools dump hello.go.wasm

wasm_fault_injection.go.wasm 配置到 APISIX 到 config.yaml,并将该插件命名为 wasm_fault_injection。

1apisix:
2        ...
3wasm:
4  plugins:
5    - name: wasm_fault_injection
6      priority: 7997
7      file: wasm_fault_injection.go.wasm

之后,我们启动 APISIX ,并创建一条路由引用该 Wasm 插件:

1curl  http://127.0.0.1:9180/apisix/admin/routes/1 \
2-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{
3    "uri":"/*",
4    "upstream":{
5        "type":"roundrobin",
6        "timeout":{
7            "connect":1,
8            "read":1,
9            "send":1
10        },
11        "nodes":{
12            "httpbin.org:80":1
13        }
14    },
15    "plugins":{
16        "wasm_fault_injection":{
17            "conf":"{\"http_status\":200, \"body\":\"Hello WebAssembly!\n\"}"
18        }
19    },
20    "name":"wasm_fault_injection"
21}'
22

进行访问测试,发现响应体已被修改为 "Hello WebAssembly",由此 Wasm 插件已经生效。

1curl 127.0.0.1:9080/get -v
2*   Trying 127.0.0.1:9080...
3* Connected to 127.0.0.1 (127.0.0.1) port 9080 (#0)
4> GET /get HTTP/1.1
5> Host: 127.0.0.1:9080
6> User-Agent: curl/7.81.0
7> Accept: */*
8>
9* Mark bundle as not supporting multiuse
10< HTTP/1.1 200 OK
11< Date: Thu, 09 Feb 2023 07:46:50 GMT
12< Content-Type: text/plain; charset=utf-8
13< Transfer-Encoding: chunked
14< Connection: keep-alive
15< Server: APISIX/3.1.0
16<
17Hello WebAssembly!

Wasm-nginx-module

了解完 Apache APISIX 如何使用 Wasm 插件,现在我们更进一步来了解 "为什么我们能在 Wasm 插件中获取到请求的内容并修改请求?" 。 由于 APISIX 选用 Openresty 作为底层框架,因此 Wasm 插件中想要能够获取到请求内容和修改请求内容,就需要和 openResty 或者 NGINX 提供的 API 进行交互。wasm-nginx-module 正是提供了这部分能力。

wasm-nginx-module 是由 API7 研发的支持 Wasm 的 NGINX 模块。

该模块尝试在 NGINX 的基础上实现 proxy-wasm-abi,并且向上封装了 Lua API,使得我们能够在 Lua 层面完成 proxy-wasm-abi 的调用。 更多内容可参考 wasm-nginx-module

例如,当我们的 APISIX 运行到 "access" 阶段时,会调用 wasm-nginx-module 中提供的 Lua 方法 on_http_request_headers。

1-- apisix/wasm.lua
2...
3local ok, err = wasm.on_http_request_headers(plugin_ctx)
4   if not ok then
5       core.log.error(name, ": failed to run wasm plugin: ", err)
6       return 503
7   end
8end
9...
10

之后在该方法中,将调用 wasm-nginx-modulengx_http_wasm_on_http 方法,

1ngx_int_t
2ngx_http_wasm_on_http(ngx_http_wasm_plugin_ctx_t *hwp_ctx, ngx_http_request_t *r,
3                      ngx_http_wasm_phase_t type, const u_char *body, size_t size,
4                      int end_of_body)
5{
6    ...
7
8    ctx = ngx_http_wasm_get_module_ctx(r);
9
10    if (type == HTTP_REQUEST_HEADERS) {
11        cb_name = &proxy_on_request_headers;
12    } else if (type == HTTP_REQUEST_BODY) {
13        cb_name = &proxy_on_request_body;
14    } else if (type == HTTP_RESPONSE_HEADERS) {
15        cb_name = &proxy_on_response_headers;
16    } else {
17        cb_name = &proxy_on_response_body;
18    }
19
20    if (type == HTTP_REQUEST_HEADERS || type == HTTP_RESPONSE_HEADERS) {
21        if (hwp_ctx->hw_plugin->abi_version == PROXY_WASM_ABI_VER_010) {
22            rc = ngx_wasm_vm->call(hwp_ctx->hw_plugin->plugin,
23                                   cb_name,
24                                   true, NGX_WASM_PARAM_I32_I32, http_ctx->id, 0);
25        } else {
26            rc = ngx_wasm_vm->call(hwp_ctx->hw_plugin->plugin,
27                                   cb_name,
28                                   true, NGX_WASM_PARAM_I32_I32_I32, http_ctx->id,
29                                   0, 1);
30        }
31
32    } else {
33        rc = ngx_wasm_vm->call(hwp_ctx->hw_plugin->plugin,
34                              cb_name,
35                              true, NGX_WASM_PARAM_I32_I32_I32, http_ctx->id,
36                              size, end_of_body);
37    }
38    ...
39}

wasm-nginx-module 中,我们将根据不同的阶段,设置 cb_name,例如:HTTP_REQUEST_HEADERS 对应 proxy_on_request_headers,之后将在 ngx_wasm_vm->call 中调用 vm 中的方法也就是我们在上文中提到的 wasm 插件 OnHttpRequestHeaders 的方法。

至此,整个 APISIX 调用 wasm 插件,运行 Golang 的调用链便梳理完成,调用链如下:

wasm-call

Wasm VM

Wasm VM 用于真正执行 Wasm 代码的虚拟机,在 wasm-nginx-module 中实现了对两种虚拟机 "wasmtime" 和 "wasmedge" 两种虚拟机,在 APISIX 中默认选择使用 "wasmtime" 作为 Wasm 代码的运行虚拟机。

Wasmtime

Wasmtime 是由 bytecodealliance 开源的 WebAssembly 和 WASI 的小型高效运行时。它能够在 Web 外部运行 WebAssembly 代码,即可以用作命令行使用,也可以作为 WebAssembly 运行引擎嵌入到其他程序作为库使用。 Wasmedge Wasmedge 是为边缘计算优化的轻量级、高性能、可扩展的 WebAssembly (Wasm) 虚拟机,可用于云原生、边缘和去中心化的应用。

在 Wasm vm 中首先通过 load 方法将 .wasm 文件加载到内存,之后我们便可以通过 VM 的 call 方法来调用这些方法。VM 底层依托于 WASI 的接口实现,使得 Wasm 代码不仅能够运行在浏览器端,同时也支持能够在服务端进行。

总结

通过本文我们了解到 Wasm 是什么以及 APISIX 如何支持 Wasm 插件。APISIX 通过支持 Wasm 插件,不但可以扩充对多语言的支持,例如通过 C++, Rust, Golang, AssemblyScript 等进行插件开发,而且由于 WebAssembly 正在从浏览器走向云原生拥有了更加丰富的生态与使用场景,因此 APISIX 也可以借助 Wasm 完成在 API 网关侧更多的扩展功能,解决更多使用场景。

微信咨询

获取方案