[FLUME-3269] Support JSSE keystore/trustore -D system properties

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.9.0
• Assignee: Peter Turcsanyi
• Reporter: Peter Turcsanyi
• Created: 15/Aug/18 12:43
• Updated: 05/Oct/18 11:20
• Resolved: 05/Oct/18 09:51

Description

Several Flume components support SSL, but they all have their own config parameters for specifying the location and password for keystore and truststore.

These parameters could be passed as standard JSSE system properties (specified in flume-env.sh):

-Djavax.net.ssl.keyStore=/path/to/keystore
-Djavax.net.ssl.keyStorePassword=keystore-password
-Djavax.net.ssl.keyStoreType=keystore-type
-Djavax.net.ssl.trustStore=/path/to/truststore
-Djavax.net.ssl.trustStorePassword=truststore-password
-Djavax.net.ssl.trustStoreType=truststore-type

This would be a more consistent and standard based configuration.

Specifying passwords in system properties means that the passwords can be seen in the process list. For cases where it is not acceptable, it will also be possible to define the parameters in environment variables.

FLUME_SSL_KEYSTORE_PATH
FLUME_SSL_KEYSTORE_PASSWORD
FLUME_SSL_KEYSTORE_TYPE
FLUME_SSL_TRUSTSTORE_PATH
FLUME_SSL_TRUSTSTORE_PASSWORD
FLUME_SSL_TRUSTSTORE_TYPE

The logic of applying the SSL config parameters for an SSL-enabled source/sink:

• if the agent config defines the SSL parameter for the component, then they will be used (allowing customisation and backward compatibility)
• if no SSL parameters are defined for the component, but the -D system properties are present, then they will be used
• if neither the component SSL parameters nor the -D system properties are defined, but the environment variable are present, then they will be used
• otherwise config error

So the priority:

1. component parameters in agent config
2. -D system properties
3. environment variables

Issue Links

• links to: GitHub Pull Request #228