跳到主要内容
版本:3.2.16.6

配置客户端与 API7 企业版之间的 mTLS

双向 TLS(mTLS)是传输层安全协议(TLS)的增强形式,让客户端和服务器能够相互验证身份。在握手过程中,双方交换并验证彼此的证书,以确认对方的身份。

本指南介绍如何在客户端与 API7 企业版之间配置 mTLS,以防止未经授权的访问并增强安全性。

按照以下互动演示中的步骤操作,了解如何在 API7 企业版中使用 mTLS。

前提条件​

生成证书和密钥​

  1. 生成证书颁发机构(CA)的密钥和证书。

    openssl genrsa -out ca.key 2048 && \
    openssl req -new -sha256 -key ca.key -out ca.csr -subj "/CN=ROOTCA" && \
    openssl x509 -req -days 36500 -sha256 -extensions v3_ca -signkey ca.key -in ca.csr -out ca.crt
  2. 为 API7 企业版生成密钥和公用名(CN)为 test.com 的证书,并使用 CA 证书签名。

    openssl genrsa -out server.key 2048 && \
    openssl req -new -sha256 -key server.key -out server.csr -subj "/CN=test.com" && \
    openssl x509 -req -days 36500 -sha256 -extensions v3_req \
    -CA ca.crt -CAkey ca.key -CAserial ca.srl -CAcreateserial \
    -in server.csr -out server.crt
  3. 为客户端生成密钥和公用名为 CLIENT 的证书,并使用 CA 证书签名。

    openssl genrsa -out client.key 2048 && \
    openssl req -new -sha256 -key client.key -out client.csr -subj "/CN=CLIENT" && \
    openssl x509 -req -days 36500 -sha256 -extensions v3_req \
    -CA ca.crt -CAkey ca.key -CAserial ca.srl -CAcreateserial \
    -in client.csr -out client.crt
  4. 生成证书和密钥后,在你的本地设备上找到以下文件。

    ❶ server.crt 为服务器证书。

    ❷ server.key 为服务器证书的私钥。

    ❸ ca.crt 为 CA 证书。

为 API7 企业版配置 mTLS​

  1. 打开 API7 企业版控制台,选择 default 网关组。从侧边栏选择 SSL 证书,然后点击 + 新增 SSL 证书。

  2. 在 + 新增 SSL 证书对话框中完成以下操作。

    • 在类型字段中选择 服务器。
    • 选择上传方式。
    • 在 证书 字段中上传 server.crt 文件。
    • 在 私钥 字段中上传 server.key 文件。
    • 启用对等验证。
    • 在 CA 证书(可选) 字段中上传 ca.crt 文件。
    • 点击 新增。
  3. 添加完成后,SSL 证书会有一个 ID,SNIS 为 test.com。

验证客户端与 API7 企业版之间的 mTLS 连接​

使用客户端证书进行请求​

该证书仅对公用名 test.com 有效,请使用 test.com 作为访问 API7 企业版的域名。

使用客户端证书发送请求至 https://test.com:9443/ip,并将 test.com 解析为 127.0.0.1。

curl -ikv --resolve "test.com:9443:127.0.0.1" "https://test.com:9443/ip" \
--cert client.crt --key client.key

类似以下输出的 mTLS 握手表明客户端与 API7 企业版之间已启用 mTLS。

* Added test.com:9443:127.0.0.1 to DNS cache
* Hostname test.com was found in DNS cache
* Trying 127.0.0.1:9443...
* Connected to test.com (127.0.0.1) port 9443
* ALPN: curl offers h2,http/1.1
* (304) (OUT), TLS handshake, Client hello (1):
* (304) (IN), TLS handshake, Server hello (2):
* (304) (IN), TLS handshake, Unknown (8):
* (304) (IN), TLS handshake, Request CERT (13):
* (304) (IN), TLS handshake, Certificate (11):
* (304) (IN), TLS handshake, CERT verify (15):
* (304) (IN), TLS handshake, Finished (20):
* (304) (OUT), TLS handshake, Certificate (11):
* (304) (OUT), TLS handshake, CERT verify (15):
* (304) (OUT), TLS handshake, Finished (20):
* SSL connection using TLSv1.3 / AEAD-AES256-GCM-SHA384 / [blank] / UNDEF
* ALPN: server accepted h2
* Server certificate:
* subject: CN=test.com
* start date: Jul 31 08:50:42 2024 GMT
* expire date: Jul 7 08:50:42 2124 GMT
* issuer: CN=ROOTCA
* SSL certificate verify result: unable to get local issuer certificate (20), continuing anyway.
* using HTTP/2
* [HTTP/2] [1] OPENED stream for https://test.com:9443/ip
* [HTTP/2] [1] [:method: GET]
* [HTTP/2] [1] [:scheme: https]
* [HTTP/2] [1] [:authority: test.com:9443]
* [HTTP/2] [1] [:path: /ip]
* [HTTP/2] [1] [user-agent: curl/8.6.0]
* [HTTP/2] [1] [accept: */*]
> GET /ip HTTP/2
> Host: test.com:9443
> User-Agent: curl/8.6.0
> Accept: */*
>
< HTTP/2 200
HTTP/2 200
...

API7 企业版和客户端在握手期间成功验证了彼此的证书,并建立了连接。

无客户端证书情况下进行请求​

在无客户端证书的情况下,发送请求到 https://test.com:9443/ip。

curl -ikv --resolve "test.com:9443:127.0.0.1" "https://test.com:9443/ip"

mTLS 握手失败时,输出类似如下所示。

* Added test.com:9443:127.0.0.1 to DNS cache
* Hostname test.com was found in DNS cache
* Trying 127.0.0.1:9443...
* Connected to test.com (127.0.0.1) port 9443
* ALPN: curl offers h2,http/1.1
* (304) (OUT), TLS handshake, Client hello (1):
* (304) (IN), TLS handshake, Server hello (2):
* (304) (IN), TLS handshake, Unknown (8):
* (304) (IN), TLS handshake, Request CERT (13):
* (304) (IN), TLS handshake, Certificate (11):
* (304) (IN), TLS handshake, CERT verify (15):
* (304) (IN), TLS handshake, Finished (20):
* (304) (OUT), TLS handshake, Certificate (11):
* (304) (OUT), TLS handshake, Finished (20):
* SSL connection using TLSv1.3 / AEAD-AES256-GCM-SHA384 / [blank] / UNDEF
* ALPN: server accepted h2
* Server certificate:
* subject: CN=test.com
* start date: Jul 31 08:50:42 2024 GMT
* expire date: Jul 7 08:50:42 2124 GMT
* issuer: CN=ROOTCA
* SSL certificate verify result: unable to get local issuer certificate (20), continuing anyway.
* using HTTP/2
* [HTTP/2] [1] OPENED stream for https://test.com:9443/ip
* [HTTP/2] [1] [:method: GET]
* [HTTP/2] [1] [:scheme: https]
* [HTTP/2] [1] [:authority: test.com:9443]
* [HTTP/2] [1] [:path: /ip]
* [HTTP/2] [1] [user-agent: curl/8.6.0]
* [HTTP/2] [1] [accept: */*]
> GET /ip HTTP/2
> Host: test.com:9443
> User-Agent: curl/8.6.0
> Accept: */*
>
* LibreSSL SSL_read: LibreSSL/3.3.6: error:1404C45C:SSL routines:ST_OK:reason(1116), errno 0
* Failed receiving HTTP2 data: 56(Failure when receiving data from the peer)
* Connection #0 to host test.com left intact

由于缺少客户端证书,握手失败。

相关阅读​