Apache APISIX中实现mTLS请求的Lua插件开发指南

背景介绍

在微服务架构中，mTLS（双向TLS）认证是一种重要的安全机制，它要求通信双方都提供证书进行身份验证。Apache APISIX作为云原生API网关，支持通过Lua插件扩展功能。本文将详细介绍如何在APISIX中开发一个能够发起mTLS请求的Lua插件。

问题现象

开发者在尝试从自定义插件发起mTLS请求时遇到了证书验证失败的问题。具体表现为：

1. 使用TLSv1.3时出现错误："SSL_read() failed (SSL: error:1409445C:SSL routines:ssl3_read_bytes:tlsv13 alert certificate required:SSL alert number 116)"
2. 使用TLSv1.2时出现错误："SSL routines:SSL3_READ_BYTES:sslv3 alert bad certificate:s3_pkt.c:1259:SSL alert number 42"

通过Wireshark抓包分析确认，客户端证书确实没有被正确发送。

根本原因

APISIX使用了特定分支的lua-resty-http库（api7-lua-resty-http），其API与上游的ledgetech版本存在差异：

1. 上游版本使用ssl_client_cert和ssl_client_priv_key参数
2. APISIX分支版本使用ssl_cert和ssl_key参数

这种API差异导致了开发者按照常规方法配置时，证书无法被正确加载。

解决方案

正确的mTLS请求实现方式

在APISIX插件中发起mTLS请求时，应使用以下参数格式：

local ok, err = httpc:connect {
    ssl_cert = cert_in_pem_format,  -- 客户端证书(PEM格式)
    ssl_key = key_in_pem_format,    -- 客户端私钥(PEM格式)
}

完整示例代码

local http = require("resty.http")
local core = require("apisix.core")

local function mtls_request()
    local httpc = http.new()
    
    -- 读取证书和私钥文件
    local cert = assert(io.open("/path/to/client.crt"):read("*a"))
    local key = assert(io.open("/path/to/client.key"):read("*a"))
    
    -- 建立mTLS连接
    local ok, err = httpc:connect {
        scheme = "https",
        host = "target.server",
        port = 443,
        ssl_verify = true,
        ssl_cert = cert,
        ssl_key = key,
    }
    
    if not ok then
        core.log.error("failed to connect: ", err)
        return
    end
    
    -- 发送请求
    local res, err = httpc:request {
        path = "/api/endpoint",
        method = "GET",
    }
    
    -- 处理响应
    if not res then
        core.log.error("failed to request: ", err)
        return
    end
    
    -- 读取响应体
    local body = res:read_body()
    httpc:close()
    
    return body
end

最佳实践

1. 证书管理：将证书和私钥存储在APISIX的机密存储中，而不是直接硬编码在插件代码里
2. 错误处理：完善各种错误情况的处理逻辑，包括连接失败、证书验证失败等
3. 性能优化：考虑复用HTTP连接，避免每次请求都建立新的TLS握手
4. 日志记录：详细记录请求过程中的关键信息，便于问题排查

注意事项

1. 确保提供的证书和私钥是PEM格式
2. 检查证书链是否完整，中间CA证书需要包含在客户端证书中或服务器信任链中
3. 验证服务器证书时，确保APISIX信任服务器的CA证书
4. 不同版本的APISIX可能使用不同版本的lua-resty-http库，注意API兼容性

总结

在Apache APISIX中实现mTLS请求需要注意其使用的特定分支的HTTP库的API差异。通过正确使用ssl_cert和ssl_key参数，开发者可以成功构建安全的mTLS通信。理解底层库的实现细节对于解决此类问题至关重要，这也体现了APISIX插件开发中需要关注框架特定实现的特点。