Using encrypted passwords with Pentaho products

How you apply an encrypted password varies by product.

• Pentaho Data Integration (PDI)

• Pentaho User Console (PUC)

  • PUC email

• Pentaho Aggregation Designer

• Pentaho Metadata Editor (PME)

• Pentaho Report Designer (PRD)

Pentaho Data Integration (PDI)

Perform the following steps to use an encrypted password with Pentaho Data Integration (PDI).

1. Stop the server.

   For instructions on stopping the server, see Stop and start the Pentaho Server and repository.

2. Navigate to the design-tools/data-integration/simple-jndi directory.

3. Open the jdbc.properties file with any text editor.

4. Replace all instances of the password value with the encrypted password.

5. Save and close the file.

6. Restart the server and verify that all passwords are now using encrypted values.

Pentaho User Console (PUC)

Perform the following steps to use an encrypted password with the Pentaho User Console (PUC).

1. Stop the server.

   For instructions on stopping the server, see Stop and start the Pentaho Server and repository.

2. Navigate to the server/pentaho-server/tomcat/webapps/pentaho/META-INF directory.

3. Open the context.xml file in any text editor.

4. Replace the password value in every Resource element with the encrypted password.

5. Save and close the file.

6. Restart the server and verify that all passwords are now using encrypted values.

PUC email

After you have configured the Pentaho User Console (PUC) with an encrypted password, you can use that password with PUC email.

Perform the following steps to use an encrypted password with PUC email.

1. Log in to PUC as an administrator.

2. Open the Administration Perspective and click the Mail server section.

3. Enter your encrypted password value in the password field.

   Note: If you use Gmail, enable allow less secure apps to access your account.

4. Click Test Email Configuration.

5. Verify that an email was sent to the address you specified.

Pentaho Aggregation Designer

To use encrypted passwords with Pentaho Aggregation Designer, you must first centralize your passwords in a jndi.properties file.

Perform the following steps to use an encrypted password with the Pentaho Aggregation Designer.

1. Stop the server.

   For instructions on stopping the server, see Stop and start the Pentaho Server and repository.

2. Create a jndi.properties file to set the default properties:

   java.naming.factory.initial=org.osjava.sj.SimpleContextFactory
   org.osjava.sj.root=file://C:/Users/<*username*>/.pentaho/simple-jndi
   org.osjava.sj.delimiter=/

3. Save the jndi.properties file in the design-tools/aggregation-designer/lib directory.

4. In the user’s home directory, navigate to the .pentaho/simple-jndi directory.

   • Open the default.properties file with any text editor.

   • If default.properties does not exist, create it.

   • If you created default.properties under design-tools/aggregation-designer/simple-jndi, update org.osjava.sj.root in design-tools/aggregation-designer/lib/jndi.properties to point to it. Example:

     org.osjava.sj.root=file://<*install directory*>/design-tools/aggregation-designer/simple-jndi

5. Replace the password value in every property in default.properties with the encrypted password.

   Note: If you use a remote repository, change localhost to the remote repository IP address.

6. Save and close the file.

7. Restart the server and verify that all passwords are now using encrypted values.

Pentaho Metadata Editor (PME)

The Pentaho Metadata Editor (PME) stores passwords in the JNDI connection default.properties file. For setup details, see Define JNDI connections for Report Designer and Metadata Editor.

Perform the following steps to use an encrypted password with the PME:

1. Stop the server.

   For instructions on stopping the server, see Stop and start the Pentaho Server and repository.

2. In the user’s home directory, navigate to the .pentaho/simple-jndi directory.

3. Open the default.properties file with any text editor.

   Note: If default.properties does not exist, create it.

4. Replace the password value in every property in the file with the encrypted password.

   Note: If you use a remote repository, change localhost to the remote repository IP address.

5. Save and close the file.

6. Restart the server and verify that all passwords are now using encrypted values.

Pentaho Report Designer (PRD)

The Pentaho Report Designer (PRD) stores passwords in the JNDI connection default.properties file. For setup details, see Define JNDI connections for Report Designer and Metadata Editor.

Perform the following steps to use an encrypted password with the PRD:

1. Stop the server.

   For instructions on stopping the server, see Stop and start the Pentaho Server and repository.

2. Navigate to the design-tools/report-designer/configuration-template/simple-jndi directory.

3. Open the default.properties file with any text editor.

4. Replace the password value in every property in the file with the encrypted password.

   Note: If you use a remote repository, update the localhost address to the correct IP. Use the encrypted password for every occurrence of the password.

5. Save and close the file.

6. Copy default.properties to the .pentaho/simple-jndi directory in the user’s home directory. Replace the existing file.

   Note: If the .pentaho/simple-jndi directory does not exist, create it.

7. Restart the server and verify that all passwords are now using encrypted values.

After you update a product

After you configure a product to use encrypted passwords, all logins with that product use encrypted passwords.

Connect to any databases you updated to verify the changes.