By default, the password that Archive uses to connect to its datasource is stored as cleartext.
To mitigate this security risk, Archive can store an encrypted password. This ensures that the password is not revealed when Archive configuration files are viewed or shared.
Note
An Archive system’s datasource is a database, so the subject of this guide is the database connection password.
Note
This guide applies only to Archive systems running in standalone mode.
In summary, the implementation process for encrypting the Lasernet Archive datasource password is:
The steps are described in detail below.
Prerequisite Steps
Download the Required Files
To implement datasource password encryption, you will need the following components:
efs-pbetool.jar: A CLI tool that encrypts the password.pbeloginmodule-1.0.1-module.zip: A ZIP archive that contains the Wildfly module that decrypts the password at runtime.
These components are packaged into a single ZIP file. This package includes PbeLoginModule-1.0.1.
https://lngsupportdownloads.blob.core.windows.net/autoformdm/Tools/pbeloginmodule-1.0.1-dist.zip
Back Up the Current Lasernet Archive Configuration File
Locate the standalone.xml Archive configuration file and make a backup copy of it. This file is in the \standalone\configuration directory of the Wildfly application server.
For example, if Archive is installed to create a node named Production and it is installed to its default location, the configuration file is C:\Program Files\Lasernet\Lasernet Archive\Server_11.3 - Production\wildfly-<version number>.Final\standalone\configuration\standalone.xml.
Install the Custom Wildfly Login Module
To install the password decryption module:
Open the ZIP file that you downloaded and then find
pbeloginmodule-1.0.1-module.zipwithin it.Extract
pbeloginmodule-1.0.1-module.zipto themodulesdirectory of the Wildfly application server.Note
For example, if Archive is installed to create a node named Production and it is installed to its default location, unpack the ZIP file’s contents to
C:\Program Files\Lasernet\Lasernet Archive\Server_11.3 - Production\wildfly-<version number>.Final\modules\.
The Wildfly application server’s directory structure will now include a \modules\com\formpipe\tools\main directory.
Generate an Encrypted Password
In summary, during this part of the process you use the efs-pbetool CLI tool to encrypt the password. After the tool outputs the encrypted password, make a note of it because you will need the encrypted password during the next stage of this process.
Open the ZIP file that you downloaded and then extract
efs-pbetool.jarfrom it.Depending on whether you want to use the default encryption key or you want to provide one, follow the instructions in the appropriate following section:
Note
In the commands in the following sections, substitute
<db-password>for the datasource password.Make a note of the encrypted password that
efs-pbetool.jargenerates.
Use the Default Key to Encrypt the Password
Run the following command: java -jar efs-pbetool.jar <db-password>
Use a Provided Key to Encrypt the Password
If you want to provide your own encryption key to encrypt the password (instead of using the default key), follow these steps:
Generate the key value that you want to use.
Add the key to a file named
encryption.key.Run the following command. Substitute
<path to encryption.key file>for the path to theencryption.keyfile that you created.java -jar efs-pbetool.jar <db-password> <path to encryption.key file>Note
The path must be an absolute path that contains / (forward slashes). UNC paths are not supported.
Configure Lasernet Archive
This part of the process adds the encrypted password to the Archive configuration and configures Archive to decrypt the password.
Locate Readme.md in pbeloginmodule-1.0.1-dist.zip and follow the instructions in the ### Modify the datasource configuration part of that file. The process involves running a script that makes the necessary changes to Archive.
Start Lasernet Archive
Start Archive. It will read the encrypted password from the configuration file, decrypt it, and then use the password to connect to the datasource.
Troubleshooting and Rollback
If you encounter any issues, check the server logs for relevant messages.
If necessary, use the backup of the unmodified standalone.xml file to revert the configuration changes.
