You are viewing the RapidMiner Server documentation for version 9.7 -Check here for latest version
Encrypting local-security value
The values of yourlocal-security.properties
can be encrypted in order to better protect yourLDAP/SAMLconfiguration.
The following steps have to be followed in the order they are presented. If you place an encrypted value in the properties file without configuring the appropriate setting, Server will fail to start.
Configure the Server Settings
First you need to create a new Server property that will contain your encryption key. Your new property should be calledcom.rapidanalytics.encryption.key
and the value should be whatever encryption key you choose.
Your settings page should look similar to the one above. Replace "secret" with your encryption key. You can find more info about Modifying System Settingshere.
Encrypt the value
In order to encrypt the value you need to use the jasypt utility which is bundled with RapidMiner Server.
Navigate to the\ bin
folder. We will be using theencrypt
utility (. sh
for UNIX systems and.bat
for Windows systems). From the command line, use the encrypt utility as shown below for your operating system.
ReplacePROPERTY
with the value of the property you want to encrypt, andENCRYPTION_KEY
with the key you defined in the Server Settings.
.\encrypt input=PROPERTY password=ENCRYPTION_KEY algorithm=PBEWithMD5AndTripleDES ----ENVIRONMENT----------------- Runtime: Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.102-b14 ----ARGUMENTS------------------- algorithm: PBEWithMD5AndTripleDES input: PROPERTY password: secret ----OUTPUT---------------------- aXl9Hfj3gIt7jpHN2MUINmHj33/cGAHL
ReplacePROPERTY
with the value of the property you want to encrypt, andENCRYPTION_KEY
with the key you defined in the Server Settings.
Note: DoNOTcomplete the next step if you haveNOTconfigured the Server Setting with your encryption key in the previous step. Doing so will prevent Server from starting, and willNOTallow you to continue with the configuration.
Open yourlocal-security.properties
file and replace the property value you encrypted with the Output string, surrounded byENC(xxxxxx). For example:
ldap.password=changeit
Becomes:
ldap.password=ENC(aXl9Hfj3gIt7jpHN2MUINmHj33/cGAHL)
After this, you can restart Server, and if properly configured, yourLDAP/SAMLconnection should work as expected. If you still have not configured yourLDAP/SAMLconnection, you can learn how to configureLDAP hereandSAML here.