Encryption

hstream supported encryption between servers and clients using TLS, in this chapter, we will not introduce more details about TLS, instead, we will only show steps and configurations to enable it.

Steps

If you don’t have any existed CA(Certificate Authority), you can create one locally, and TLS requires that each server have a key and the corresponding signed certificate, openssl is a good tool to generate them, after that, you need to configure the files paths in the servers and clients sides to enable it.

Create a local CA

Create or choose a directory for storing keys and certificates:

  1. mkdir tls
  2. cd tls

Create a database file and serial number file:

  1. touch index.txt
  2. echo 1000 > serial

Get the template openssl.cnf file(the template file is intended for testing and development, do not use it in the production environment directly):

  1. wget https://raw.githubusercontent.com/hstreamdb/hstream/main/conf/openssl.cnf

Generate the CA key file:

  1. openssl genrsa -aes256 -out ca.key.pem 4096

Generate the CA certificate file:

  1. openssl req -config openssl.cnf -key ca.key.pem \
  2.     -new -x509 -days 7300 -sha256 -extensions v3_ca \
  3.     -out ca.cert.pem

Create key pair and sign certificate for a server

Here we only generate a key and certificate for one server, you should create them for all hstream servers that have a different hostname, or create a certificate including all hostnames(IP or DNS) in SANs.

Generate the server key file:

  1. openssl genrsa -out server01.key.pem 2048

Generate the server certificate request, when you input Common Name, you should write the correct hostname(e.g., localhost):

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

generate the server certificate with the generated CA:

  1. openssl ca -config openssl.cnf -extensions server_cert \
  2.     -days 1000 -notext -md sha256 \
  3.     -in server01.csr.pem -out signed.server01.cert.pem

Configure the server and clients

The options for servers:

  1. # TLS options
  2. #
  3. # enable tls, which requires tls-key-path and tls-cert-path options
  4. enable-tls: true
  6. #
  7. # key file path for tls, can be generated by openssl
  8. tls-key-path: /path/to/the/server01.key.pem
  10. # the signed certificate by CA for the key(tls-key-path)
  11. tls-cert-path: /path/to/the/signed.server01.cert.pem

Java client:

  1. HStreamClient.builder()
  2.   .serviceUrl(serviceUrl)
  3.   // optional, enable tls
  4.   .enableTls()
  5.   .tlsCaPath("/path/to/ca.cert.pem")
  7.   .build()