Skip to main content
Version: 2.8

TLS 双向认证

保护 Admin API#

为什么使用#

双向认证提供了一种更好的方法来阻止未经授权的对 APISIX Admin API 的访问。

客户端需要向服务器提供证书，服务器将检查该客户端证书是否由受信的 CA 签名，并决定是否响应其请求。

如何配置#

  1. 生成自签证书对，包括 CA、server、client 证书对。

  2. 修改 conf/config.yaml 中的配置项：

  port_admin: 9180  https_admin: true
  admin_api_mtls:    admin_ssl_ca_cert: "/data/certs/mtls_ca.crt"              # Path of your self-signed ca cert.    admin_ssl_cert: "/data/certs/mtls_server.crt"             # Path of your self-signed server side cert.    admin_ssl_cert_key: "/data/certs/mtls_server.key"         # Path of your self-signed server side key.
  1. 执行命令，使配置生效：
apisix initapisix reload

客户端如何调用#

需要将证书文件的路径与域名按实际情况替换。

  • 注意：提供的 CA 证书需要与服务端的相同。*
curl --cacert /data/certs/mtls_ca.crt --key /data/certs/mtls_client.key --cert /data/certs/mtls_client.crt  https://admin.apisix.dev:9180/apisix/admin/routes -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'

保护 ETCD#

如何配置#

你需要构建 APISIX-Openresty，并且需要在配置文件中设定 etcd.tls 来使 ETCD 的双向认证功能正常工作。

etcd:  tls:    cert: /data/certs/etcd_client.pem       # path of certificate used by the etcd client    key: /data/certs/etcd_client.key        # path of key used by the etcd client

保护路由#

为什么使用#

双向认证是一种密码学安全的验证客户端身份的手段。当你需要加密并保护流量的双向安全时很有用。

如何配置#

在配置 ssl 资源时，同时需要配置 client.ca 和 client.depth 参数，分别代表为客户端证书签名的 CA 列表，和证书链的最大深度。可参考：SSL API 文档。

下面是一个可用于生成带双向认证配置的 SSL 资源的 Python 脚本示例。如果需要，可修改 API 地址、API Key 和 SSL 资源的 ID。

#!/usr/bin/env python# coding: utf-8# 保存该文件为 ssl.pyimport sys# sudo pip install requestsimport requests
if len(sys.argv) <= 4:    print("bad argument")    sys.exit(1)with open(sys.argv[1]) as f:    cert = f.read()with open(sys.argv[2]) as f:    key = f.read()sni = sys.argv[3]api_key = "edd1c9f034335f136f87ad84b625c8f1" # Change it
reqParam = {    "cert": cert,    "key": key,    "snis": [sni],}if len(sys.argv) >= 5:    print("Setting mTLS")    reqParam["client"] = {}    with open(sys.argv[4]) as f:        clientCert = f.read()        reqParam["client"]["ca"] = clientCert    if len(sys.argv) >= 6:        reqParam["client"]["depth"] = int(sys.argv[5])resp = requests.put("http://127.0.0.1:9080/apisix/admin/ssl/1", json=reqParam, headers={    "X-API-KEY": api_key,})print(resp.status_code)print(resp.text)

使用上述 Python 脚本创建 SSL 资源：

./ssl.py ./server.pem ./server.key 'mtls.test.com' ./client_ca.pem 10
# 测试curl --resolve 'mtls.test.com:<APISIX_HTTPS_PORT>:<APISIX_URL>' "https://<APISIX_URL>:<APISIX_HTTPS_PORT>/hello" -k --cert ./client.pem --key ./client.key

注意，测试时使用的域名需要符合证书的参数。

APISIX 与上游间的双向认证#

为什么使用#

有时候上游的服务启用了双向认证。在这种情况下，APISIX 作为上游服务的客户端，需要提供客户端证书来正常与其进行通信。

如何配置#

在配置 upstream 资源时，可以使用参数 tls.client_cert 和 tls.client_key 来配置 APISIX 用于与上游进行通讯时使用的证书。可参考 Upstream API 文档。

该功能需要 APISIX 运行在 APISIX-OpenResty 上。

下面是一个与配置 SSL 时相似的 Python 脚本，可为一个已存在的 upstream 资源配置双向认证。如果需要，可修改 API 地址和API Key。

#!/usr/bin/env python# coding: utf-8# 保存该文件为 patch_upstream_mtls.pyimport sys# sudo pip install requestsimport requests
if len(sys.argv) <= 4:    print("bad argument")    sys.exit(1)with open(sys.argv[2]) as f:    cert = f.read()with open(sys.argv[3]) as f:    key = f.read()id = sys.argv[1]api_key = "edd1c9f034335f136f87ad84b625c8f1" # Change it
reqParam = {    "tls": {        "client_cert": cert,        "client_key": key,    },}
resp = requests.patch("http://127.0.0.1:9080/apisix/admin/upstreams/"+id, json=reqParam, headers={    "X-API-KEY": api_key,})print(resp.status_code)print(resp.text)

为 ID 为 testmtls 的 upstream 配置双向认证：

./patch_upstream_mtls.py testmtls ./client.pem ./client.key