TLS 身份验证概述

TLS 身份验证是 TLS 传输加密 的扩展。 不仅服务器有客户端用于验证服务器身份的密钥和证书， 客户端还有服务器用于验证客户端身份的密钥和证书。 You must have TLS transport encryption configured on your cluster before you can use TLS authentication. This guide assumes you already have TLS transport encryption configured.

Bouncy Castle Provider provides TLS related cipher suites and algorithms in Pulsar. If you need FIPS version of Bouncy Castle Provider, please reference Bouncy Castle page.

创建客户证书

Client certificates are generated using the certificate authority. Server certificates are also generated with the same certificate authority.

The biggest difference between client certs and server certs is that the common name for the client certificate is the role token which that client is authenticated as.

First, you need to enter the following command to generate the key :

  1. $ openssl genrsa -out admin.key.pem 2048

Similar to the broker, the client expects the key to be in PKCS 8 format, so you need to convert it by entering the following command:

  1. $ openssl pkcs8 -topk8 -inform PEM -outform PEM \
  2.       -in admin.key.pem -out admin.key-pk8.pem -nocrypt

接下来，输入下面的命令来生成证书请求。 When you are asked for a common name, enter the role token that you want this key pair to authenticate a client as.

  1. $ openssl req -config openssl.cnf \
  2.       -key admin.key.pem -new -sha256 -out admin.csr.pem

注意 如果未指定 openssl.cnf ，请读取 证书颁发机构 获取openssl.cnf。

然后输入下面的命令来与证书权威签约。 Note that the client certs uses the usr_cert extension, which allows the cert to be used for client authentication.

  1. $ openssl ca -config openssl.cnf -extensions usr_cert \
  2.       -days 1000 -notext -md sha256 \
  3.       -in admin.csr.pem -out admin.cert.pem

你可以从此命令获得证书、 admin.cert.pem和一个密钥。 admin.key-pk8.pem 使用 ca.cert. em， 客户可以使用此证书和此密钥向 broker 和 proxy 进行身份验证，作为 管理员

Note If the “unable to load CA private key” error occurs and the reason of this error is “No such file or directory: /etc/pki/CA/private/cakey.pem” in this step. Try the command below:

$ cd /etc/pki/tls/misc/CA $ ./CA -newca

  2. 生成 `cakey.pem`。
  4. ## 在 broker 上启用 TLS 认证
  6. 要配置 broker 来验证客户端，请在 `broker.conf`中添加以下参数，和 [配置一起启用tls transport](security-tls-transport.md#broker-configuration)：
  8. ```properties
  9. # Configuration to enable authentication
  10. authenticationEnabled=true
  11. authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderTls
  13. # operations and publish/consume from all topics
  14. superUserRoles=admin
  16. # Authentication settings of the broker itself. Used when the broker connects to other brokers, either in same or other clusters
  17. brokerClientTlsEnabled=true
  18. brokerClientAuthenticationPlugin=org.apache.pulsar.client.impl.auth.AuthenticationTls
  19. brokerClientAuthenticationParameters=tlsCertFile:/path/my-ca/admin.cert.pem,tlsKeyFile:/path/my-ca/admin.key-pk8.pem
  20. brokerClientTrustCertsFilePath=/path/my-ca/certs/ca.cert.pem

在 proxy 上启用 TLS 身份验证

要配置 proxy 服务器来验证客户端，请在 代理.conf的配置中加上 来启用tls transport:

代理服务器应该有自己的客户端密钥对。 你需要在 broker 的 代理角色 中配置此密钥对的角色标记。 详情请访问 认证指南。

  1. # For clients connecting to the proxy
  2. authenticationEnabled=true
  3. authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderTls
  5. # For the proxy to connect to brokers
  6. brokerClientAuthenticationPlugin=org.apache.pulsar.client.impl.auth.AuthenticationTls
  7. brokerClientAuthenticationParameters=tlsCertFile:/path/to/proxy.cert.pem,tlsKeyFile:/path/to/proxy.key-pk8.pem

客户端配置

When you use TLS authentication, client connects via TLS transport. You need to configure the client to use https:// and 8443 port for the web service URL, pulsar+ssl:// and 6651 port for the broker service URL.

命令行工具

命令行工具 pulsar-admin, pulsar-perf pulsar-client 使用 conf/client. onf 配置文件在 Pulsar 安装中。

你需要添加以下参数到该文件以使用 Pulsar 的 CLI 工具使用 TLS 身份验证：

  1. webServiceUrl=https://broker.example.com:8443/
  2. brokerServiceUrl=pulsar+ssl://broker.example.com:6651/
  3. useTls=true
  4. tlsAllowInsecureConnection=false
  5. tlsTrustCertsFilePath=/path/to/ca.cert.pem
  6. authPlugin=org.apache.pulsar.client.impl.auth.AuthenticationTls
  7. authParams=tlsCertFile:/path/to/my-role.cert.pem,tlsKeyFile:/path/to/my-role.key-pk8.pem

Java 客户端

  1. import org.apache.pulsar.client.api.PulsarClient;
  3. PulsarClient client = PulsarClient.builder()
  4.     .serviceUrl("pulsar+ssl://broker.example.com:6651/")
  5.     .enableTls(true)
  6.     .tlsTrustCertsFilePath("/path/to/ca.cert.pem")
  7.     .authentication("org.apache.pulsar.client.impl.auth.AuthenticationTls",
  8.                     "tlsCertFile:/path/to/my-role.cert.pem,tlsKeyFile:/path/to/my-role.key-pk8.pem")
  9.     .build();

Python client

  1. from pulsar import Client, AuthenticationTLS
  3. auth = AuthenticationTLS("/path/to/my-role.cert.pem", "/path/to/my-role.key-pk8.pem")
  4. client = Client("pulsar+ssl://broker.example.com:6651/",
  5.                 tls_trust_certs_file_path="/path/to/ca.cert.pem",
  6.                 tls_allow_insecure_connection=False,
  7.                 authentication=auth)

C++ client

  1. #include <pulsar/Client.h>
  3. pulsar::ClientConfiguration config;
  4. config.setUseTls(true);
  5. config.setTlsTrustCertsFilePath("/path/to/ca.cert.pem");
  6. config.setTlsAllowInsecureConnection(false);
  8. pulsar::AuthenticationPtr auth = pulsar::AuthTls::create("/path/to/my-role.cert.pem",
  9.                                                          "/path/to/my-role.key-pk8.pem")
  10. config.setAuth(auth);
  12. pulsar::Client client("pulsar+ssl://broker.example.com:6651/", config);

Node.js 客户端

  1. const Pulsar = require('pulsar-client');
  3. (async () => {
  4.   const auth = new Pulsar.AuthenticationTls({
  5.     certificatePath: '/path/to/my-role.cert.pem',
  6.     privateKeyPath: '/path/to/my-role.key-pk8.pem',
  7.   });
  9.   const client = new Pulsar.Client({
  10.     serviceUrl: 'pulsar+ssl://broker.example.com:6651/',
  11.     authentication: auth,
  12.     tlsTrustCertsFilePath: '/path/to/ca.cert.pem',
  13.   });
  14. })();