KrakenD Enterprise 2.0 released! Read the Release notes »

Documentation

Recent changes

Enabling TLS for HTTPS and HTTP/2

There are two different strategies when using TLS over KrakenD:

  • Use TLS for HTTPS and HTTP/2 in KrakenD (this document)
  • Use a balancer with TLS termination in front of KrakenD (e.g., ELB, HAproxy)

In case you want to enable TLS in KrakenD you need to add a tls key at service level (configuration’s file root) with at least the public key and the private key. When you add TLS, KrakenD listens only using TLS, and no traffic to plain HTTP is accepted.

TLS Configuration

To start KrakenD with TLS you need to generate the certificate and provide both the public and the private key:

{
  "version": 3,
  "tls": {
    "public_key": "/path/to/cert.pem",
    "private_key": "/path/to/key.pem"
  }
}

The mandatory options of the TLS configuration are:

  • public_key: Absolute path to the public key, or relative to the current working directory
  • private_key: Absolute path to the private key, or relative to the current working directory

Plus these optional:

  • disabled (boolean): A temporary flag to disable TLS (e.g: while in development)

  • min_version (string): Minimum TLS version (one of SSL3.0, TLS10, TLS11, TLS12 or TLS13)

  • max_version (string): Maximum TLS version (one of SSL3.0, TLS10, TLS11, TLS12 or TLS13)

  • enable_mtls (boolean): Whether to enable or not Mutual Authentication. When mTLS is enabled, all KrakenD endpoints require clients to provide a known client-side X.509 authentication certificate. KrakenD relies on the system’s CA to validate certificates. See Mutual Authentication

  • curve_preferences (integer array): The list of all the identifiers for the curve preferences (use 23 for CurveP256, 24 for CurveP384 or 25 for CurveP521)

  • prefer_server_cipher_suites (boolean): Enforces the use of one of the cipher suites offered by the server, instead of going with the suite proposed by the client.

  • cipher_suites (integer array): The list of cipher suites (see below). The list of cipher suites with its values is:

    • 5: TLS_RSA_WITH_RC4_128_SHA
    • 10: TLS_RSA_WITH_3DES_EDE_CBC_SHA
    • 47: TLS_RSA_WITH_AES_128_CBC_SHA
    • 53: TLS_RSA_WITH_AES_256_CBC_SHA
    • 60: TLS_RSA_WITH_AES_128_CBC_SHA256
    • 156: TLS_RSA_WITH_AES_128_GCM_SHA256
    • 157: TLS_RSA_WITH_AES_256_GCM_SHA384
    • 49159: TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
    • 49161: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
    • 49162: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
    • 49169: TLS_ECDHE_RSA_WITH_RC4_128_SHA
    • 49170: TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
    • 49171: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
    • 49172: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
    • 49187: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
    • 49191: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
    • 49199: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
    • 49195: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
    • 49200: TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
    • 49196: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
    • 52392: TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305
    • 52393: TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305

TLS 1.3:

  • 4865: TLS_AES_128_GCM_SHA256
  • 4866: TLS_AES_256_GCM_SHA384
  • 4867: TLS_CHACHA20_POLY1305_SHA256

Default suites are:

  • 49199: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • 49195: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • 49200: TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • 49196: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • 52392: TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305
  • 52393: TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305

Generate a certificate

Example to generate a self-signed certificate from the command line:

Generate a certificate 
$openssl req -newkey rsa:2048 -new -nodes -x509 -days 365 -out cert.pem -keyout key.pem -subj \"/C=US/ST=California/L=Mountain View/O=Your Organization/OU=Your Unit/CN=localhost\" 

Unresolved issues?

The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.

We use cookies to understand how you use our site and to improve your overall experience. By continuing to use our site, you accept our Privacy Policy. More information