Authentication using TLS

TLS Authentication Overview

TLS authentication is an extension of TLS transport encryption, but instead of only servers having keys and certs which the client uses to verify the server's identity, clients also have keys and certs which the server uses to verify the client's identity. 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.

Creating client certificates

Client certificates are generated using the same certificate authority as was used to generate the server certificates.

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 will be authenticated as.

First 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 convert it.

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

Generate the certificate request. When asked for a common name, enter the role token which 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

NoteIf there is no openssl.cnf, please read Certificate authority to get the openssl.cnf.

Sign with request with the certificate authority. Note that that 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

This will give you a cert, admin.cert.pem, and a key, admin.key-pk8.pem, which, with ca.cert.pem, can be used by clients to authenticate themselves to brokers and proxies as the role token admin.

NoteIf got "unable to load CA private key" error and the reason is "No such file or directory: /etc/pki/CA/private/cakey.pem" in this step. Please try :

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

to generate cakey.pem .

Enabling TLS Authentication …

… on Brokers

To configure brokers to authenticate clients, put the following in broker.conf, alongside the configuration to enable tls transport:

  1. # Configuration to enable authentication
  2. authenticationEnabled=true
  3. authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderTls

… on Proxies

To configure proxies to authenticate clients, put the folling in proxy.conf, alongside the configuration to enable tls transport:

The proxy should have its own client key pair for connecting to brokers. The role token for this key pair should be configured in the proxyRoles of the brokers. See the authorization guide for more details.

  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

Client configuration

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

CLI tools

Command-line tools like pulsar-admin, pulsar-perf, and pulsar-client use the conf/client.conf config file in a Pulsar installation.

You'll need to add the following parameters to that file to use TLS authentication with Pulsar's CLI tools:

  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 client

  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);