# SSL Setup

This page provides instructions on how to enable TLS/SSL authentication and encryption for network communication with and between Flink processes.

## Internal and External Connectivity

When securing network connections between machines processes through authentication and encryption, Apache Flink differentiates between _internal_ and _external_ connectivity. _Internal Connectivity_ refers to all connections made between Flink processes. These connections run Flink custom protocols. Users never connect directly to internal connectivity endpoints. _External / REST Connectivity_ endpoints refers to all connections made from the outside to Flink processes. This includes the web UI and REST commands to start and control running Flink jobs/applications, including the communication of the Flink CLI with the JobManager / Dispatcher.

For more flexibility, security for internal and external connectivity can be enabled and configured separately.

![Internal and External Connectivity](img/ssl_internal_external.svg)

### Internal Connectivity

Internal connectivity includes:

*   Control messages: RPC between JobManager / TaskManager / Dispatcher / ResourceManager
*   The data plane: The connections between TaskManagers to exchange data during shuffles, broadcasts, redistribution, etc.
*   The Blob Service (distribution of libraries and other artifacts).

All internal connections are SSL authenticated and encrypted. The connections use **mutual authentication**, meaning both server and client side of each connection need to present the certificate to each other. The certificate acts effectively as a shared secret.

A common setup is to generate a dedicated certificate (may be self-signed) for a Flink deployment. The certificate for internal communication is not needed by any other party to interact with Flink, and can be simply added to the container images, or attached to the YARN deployment.

_Note: Because internal connections are mutually authenticated with shared certificates, Flink can skip hostname verification. This makes container-based setups easier._

### External / REST Connectivity

All external connectivity is exposed via an HTTP/REST endpoint, used for example by the web UI and the CLI:

*   Communication with the _Dispatcher_ to submit jobs (session clusters)
*   Communication with the _JobManager_ to inspect and modify a running job/application

The REST endpoints can be configured to require SSL connections. The server will, however, accept connections from any client by default, meaning the REST endpoint does not authenticate the client.

Simple mutual authentication may be enabled by configuration if authentication of connections to the REST endpoint is required, but we recommend to deploy a “side car proxy”: Bind the REST endpoint to the loopback interface (or the pod-local interface in Kubernetes) and start a REST proxy that authenticates and forwards the requests to Flink. Examples for proxies that Flink users have deployed are [Envoy Proxy](https://www.envoyproxy.io/) or [NGINX with MOD_AUTH](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html).

The rationale behind delegating authentication to a proxy is that such proxies offer a wide variety of authentication options and thus better integration into existing infrastructures.

### Queryable State

Connections to the queryable state endpoints is currently not authenticated or encrypted.

## Configuring SSL

SSL can be enabled separately for _internal_ and _external_ connectivity:

*   **security.ssl.internal.enabled**: Enable SSL for all _internal_ connections.
*   **security.ssl.rest.enabled**: Enable SSL for _REST / external_ connections.

_Note: For backwards compatibility, the **security.ssl.enabled** option still exists and enables SSL for both internal and REST endpoints._

For internal connectivity, you can optionally disable security for different connection types separately. When `security.ssl.internal.enabled` is set to `true`, you can set the following parameters to `false` to disable SSL for that particular connection type:

*   `taskmanager.data.ssl.enabled`: Data communication between TaskManagers
*   `blob.service.ssl.enabled`: Transport of BLOBs from JobManager to TaskManager
*   `akka.ssl.enabled`: Akka-based RPC connections between JobManager / TaskManager / ResourceManager

### Keystores and Truststores

The SSL configuration requires to configure a **keystore** and a **truststore**. The _keystore_ contains the public certificate (public key) and the private key, while the truststore contains the trusted certificates or the trusted authorities. Both stores need to be set up such that the truststore trusts the keystore’s certificate.

#### Internal Connectivity

Because internal communication is mutually authenticated, keystore and truststore typically contain the same dedicated certificate. The certificate can use wild card hostnames or addresses, because the certificate is expected to be a shared secret and host names are not verified. It is even possible to use the same file (the keystore) also as the truststore.



```
security.ssl.internal.keystore: /path/to/file.keystore
security.ssl.internal.keystore-password: keystore_password
security.ssl.internal.key-password: key_password
security.ssl.internal.truststore: /path/to/file.truststore
security.ssl.internal.truststore-password: truststore_password
```



#### REST Endpoints (external connectivity)

For REST endpoints, by default the keystore is used by the server endpoint, and the truststore is used by the REST clients (including the CLI client) to accept the server’s certificate. In the case where the REST keystore has a self-signed certificate, the truststore must trust that certificate directly. If the REST endpoint uses a certificate that is signed through a proper certification hierarchy, the roots of that hierarchy should be in the trust store.

If mutual authentication is enabled, the keystore and the truststore are used by both, the server endpoint and the REST clients as with internal connectivity.



```
security.ssl.rest.keystore: /path/to/file.keystore
security.ssl.rest.keystore-password: keystore_password
security.ssl.rest.key-password: key_password
security.ssl.rest.truststore: /path/to/file.truststore
security.ssl.rest.truststore-password: truststore_password
security.ssl.rest.authentication-enabled: false
```



### Cipher suites

IMPORTANT The [IETF RFC 7525](https://tools.ietf.org/html/rfc7525) recommends to use a specific set of cipher suites for strong security. Because these cipher suites were not available on many setups out of the box, Flink’s default value is set to a slightly weaker but more compatible cipher suite. We recommend that SSL setups update to the stronger cipher suites, if possible, by adding the below entry to the Flink configuration:



```
security.ssl.algorithms: TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
```



If these cipher suites are not supported on your setup, you will see that Flink processes will not be able to connect to each other.

### Complete List of SSL Options

| Key | Default | Description |
| --- | --- | --- |
| 

##### security.ssl.algorithms

 | "TLS_RSA_WITH_AES_128_CBC_SHA" | The comma separated list of standard SSL algorithms to be supported. Read more [here](http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites) |
| 

##### security.ssl.internal.close-notify-flush-timeout

 | -1 | The timeout (in ms) for flushing the `close_notify` that was triggered by closing a channel. If the `close_notify` was not flushed in the given timeout the channel will be closed forcibly. (-1 = use system default) |
| 

##### security.ssl.internal.enabled

 | false | Turns on SSL for internal network communication. Optionally, specific components may override this through their own settings (rpc, data transport, REST, etc). |
| 

##### security.ssl.internal.handshake-timeout

 | -1 | The timeout (in ms) during SSL handshake. (-1 = use system default) |
| 

##### security.ssl.internal.key-password

 | (none) | The secret to decrypt the key in the keystore for Flink's internal endpoints (rpc, data transport, blob server). |
| 

##### security.ssl.internal.keystore

 | (none) | The Java keystore file with SSL Key and Certificate, to be used Flink's internal endpoints (rpc, data transport, blob server). |
| 

##### security.ssl.internal.keystore-password

 | (none) | The secret to decrypt the keystore file for Flink's for Flink's internal endpoints (rpc, data transport, blob server). |
| 

##### security.ssl.internal.session-cache-size

 | -1 | The size of the cache used for storing SSL session objects. According to https://github.com/netty/netty/issues/832, you should always set this to an appropriate number to not run into a bug with stalling IO threads during garbage collection. (-1 = use system default). |
| 

##### security.ssl.internal.session-timeout

 | -1 | The timeout (in ms) for the cached SSL session objects. (-1 = use system default) |
| 

##### security.ssl.internal.truststore

 | (none) | The truststore file containing the public CA certificates to verify the peer for Flink's internal endpoints (rpc, data transport, blob server). |
| 

##### security.ssl.internal.truststore-password

 | (none) | The password to decrypt the truststore for Flink's internal endpoints (rpc, data transport, blob server). |
| 

##### security.ssl.key-password

 | (none) | The secret to decrypt the server key in the keystore. |
| 

##### security.ssl.keystore

 | (none) | The Java keystore file to be used by the flink endpoint for its SSL Key and Certificate. |
| 

##### security.ssl.keystore-password

 | (none) | The secret to decrypt the keystore file. |
| 

##### security.ssl.protocol

 | "TLSv1.2" | The SSL protocol version to be supported for the ssl transport. Note that it doesn’t support comma separated list. |
| 

##### security.ssl.rest.authentication-enabled

 | false | Turns on mutual SSL authentication for external communication via the REST endpoints. |
| 

##### security.ssl.rest.enabled

 | false | Turns on SSL for external communication via the REST endpoints. |
| 

##### security.ssl.rest.key-password

 | (none) | The secret to decrypt the key in the keystore for Flink's external REST endpoints. |
| 

##### security.ssl.rest.keystore

 | (none) | The Java keystore file with SSL Key and Certificate, to be used Flink's external REST endpoints. |
| 

##### security.ssl.rest.keystore-password

 | (none) | The secret to decrypt the keystore file for Flink's for Flink's external REST endpoints. |
| 

##### security.ssl.rest.truststore

 | (none) | The truststore file containing the public CA certificates to verify the peer for Flink's external REST endpoints. |
| 

##### security.ssl.rest.truststore-password

 | (none) | The password to decrypt the truststore for Flink's external REST endpoints. |
| 

##### security.ssl.truststore

 | (none) | The truststore file containing the public CA certificates to be used by flink endpoints to verify the peer’s certificate. |
| 

##### security.ssl.truststore-password

 | (none) | The secret to decrypt the truststore. |
| 

##### security.ssl.verify-hostname

 | true | Flag to enable peer’s hostname verification during ssl handshake. |

## Creating and Deploying Keystores and Truststores

Keys, Certificates, and the Keystores and Truststores can be generated using the [keytool utility](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html). You need to have an appropriate Java Keystore and Truststore accessible from each node in the Flink cluster.

*   For standalone setups, this means copying the files to each node, or adding them to a shared mounted directory.
*   For container based setups, add the keystore and truststore files to the container images.
*   For Yarn/Mesos setups, the cluster deployment phase can automatically distribute the keystore and truststore files.

For the externally facing REST endpoint, the common name or subject alternative names in the certificate should match the node’s hostname and IP address.

## Example SSL Setup Standalone and Kubernetes

**Internal Connectivity**

Execute the following keytool commands to create a key pair in a keystore:



```
keytool -genkeypair -alias flink.internal -keystore internal.keystore -dname "CN=flink.internal" -storepass internal_store_password -keypass internal_key_password -keyalg RSA -keysize 4096
```



The single key/certificate in the keystore is used the same way by the server and client endpoints (mutual authentication). The key pair acts as the shared secret for internal security, and we can directly use it as keystore and truststore.



```
security.ssl.internal.enabled: true
security.ssl.internal.keystore: /path/to/flink/conf/internal.keystore
security.ssl.internal.truststore: /path/to/flink/conf/internal.keystore
security.ssl.internal.keystore-password: internal_store_password
security.ssl.internal.truststore-password: internal_store_password
security.ssl.internal.key-password: internal_key_password
```



**REST Endpoint**

The REST endpoint may receive connections from external processes, including tools that are not part of Flink (for example curl request to the REST API). Setting up a proper certificate that is signed though a CA hierarchy may make sense for the REST endpoint.

However, as mentioned above, the REST endpoint does not authenticate clients and thus typically needs to be secured via a proxy anyways.

**REST Endpoint (simple self signed certificate)**

This example shows how to create a simple keystore / truststore pair. The truststore does not contain the primary key and can be shared with other applications. In this example, _myhost.company.org / ip:10.0.2.15_ is the node (or service) for the Flink master.



```
keytool -genkeypair -alias flink.rest -keystore rest.keystore -dname "CN=myhost.company.org" -ext "SAN=dns:myhost.company.org,ip:10.0.2.15" -storepass rest_keystore_password -keypass rest_key_password -keyalg RSA -keysize 4096 -storetype PKCS12

keytool -exportcert -keystore rest.keystore -alias flink.rest -storepass rest_keystore_password -file flink.cer

keytool -importcert -keystore rest.truststore -alias flink.rest -storepass rest_truststore_password -file flink.cer -noprompt
```





```
security.ssl.rest.enabled: true
security.ssl.rest.keystore: /path/to/flink/conf/rest.keystore
security.ssl.rest.truststore: /path/to/flink/conf/rest.truststore
security.ssl.rest.keystore-password: rest_keystore_password
security.ssl.rest.truststore-password: rest_truststore_password
security.ssl.rest.key-password: rest_key_password
```



**REST Endpoint (with a self signed CA)**

Execute the following keytool commands to create a truststore with a self signed CA.



```
keytool -genkeypair -alias ca -keystore ca.keystore -dname "CN=Sample CA" -storepass ca_keystore_password -keypass ca_key_password -keyalg RSA -keysize 4096 -ext "bc=ca:true" -storetype PKCS12

keytool -exportcert -keystore ca.keystore -alias ca -storepass ca_keystore_password -file ca.cer

keytool -importcert -keystore ca.truststore -alias ca -storepass ca_truststore_password -file ca.cer -noprompt
```



Now create a keystore for the REST endpoint with a certificate signed by the above CA. Let _flink.company.org / ip:10.0.2.15_ be the hostname of the Flink master (JobManager).



```
keytool -genkeypair -alias flink.rest -keystore rest.signed.keystore -dname "CN=flink.company.org" -ext "SAN=dns:flink.company.org" -storepass rest_keystore_password -keypass rest_key_password -keyalg RSA -keysize 4096 -storetype PKCS12

keytool -certreq -alias flink.rest -keystore rest.signed.keystore -storepass rest_keystore_password -keypass rest_key_password -file rest.csr

keytool -gencert -alias ca -keystore ca.keystore -storepass ca_keystore_password -keypass ca_key_password -ext "SAN=dns:flink.company.org,ip:10.0.2.15" -infile rest.csr -outfile rest.cer

keytool -importcert -keystore rest.signed.keystore -storepass rest_keystore_password -file ca.cer -alias ca -noprompt

keytool -importcert -keystore rest.signed.keystore -storepass rest_keystore_password -keypass rest_key_password -file rest.cer -alias flink.rest -noprompt
```



Now add the following configuration to your `flink-conf.yaml`:



```
security.ssl.rest.enabled: true
security.ssl.rest.keystore: /path/to/flink/conf/rest.signed.keystore
security.ssl.rest.truststore: /path/to/flink/conf/ca.truststore
security.ssl.rest.keystore-password: rest_keystore_password
security.ssl.rest.key-password: rest_key_password
security.ssl.rest.truststore-password: ca_truststore_password
```



**Tips to query REST Endpoint with curl utility**

You can convert the keystore into the `PEM` format using `openssl`:



```
openssl pkcs12 -passin pass:rest_keystore_password -in rest.keystore -out rest.pem -nodes
```



Then you can query REST Endpoint with `curl`:



```
curl --cacert rest.pem flink_url
```



If mutual SSL is enabled:



```
curl --cacert rest.pem --cert rest.pem flink_url
```



## Tips for YARN / Mesos Deployment

For YARN and Mesos, you can use the tools of Yarn and Mesos to help:

*   Configuring security for internal communication is exactly the same as in the example above.

*   To secure the REST endpoint, you need to issue the REST endpoint’s certificate such that it is valid for all hosts that the Flink master may get deployed to. This can be done with a wild card DNS name, or by adding multiple DNS names.

*   The easiest way to deploy keystores and truststore is by YARN client’s _ship files_ option (`-yt`). Copy the keystore and truststore files into a local directory (say `deploy-keys/`) and start the YARN session as follows: `flink run -m yarn-cluster -yt deploy-keys/ flinkapp.jar`

*   When deployed using YARN, Flink’s web dashboard is accessible through YARN proxy’s Tracking URL. To ensure that the YARN proxy is able to access Flink’s HTTPS URL, you need to configure YARN proxy to accept Flink’s SSL certificates. For that, add the custom CA certificate into Java’s default truststore on the YARN Proxy node.