Skip to main content

Password Encryption

Encrypting Passwords​

You can encrypt passwords directly from the Web Interface or from a terminal.

From the Web Interface​

To encrypt a password from the Web Interface:

  1. Access the Web Interface
  2. Open the Configuration tab
  3. While configuring resources, click Encrypt password
  4. Enter the password to encrypt
  5. Click Encrypt.

From a Terminal​

Administrator privileges are required.

Run the metricshub-encrypt command:

/$ cd /opt/metricshub/bin
/opt/metricshub/bin$ ./metricshub-encrypt

Provide the password to encrypt when prompted.

Using Encrypted Passwords​

Paste the encrypted password in your configuration file:

resourceGroups:
  <resourceGroupKey>:
    resources:
      my-server:
        attributes:
          host.name: myhost-01
          host.type: storage
        protocols:
          http:
            https: true
            port: 443
            username: myusername
            password: GkwzG6bx8cUhoeQW+/1ERI+2LOyB

The Master Password​

On first use, the metricshub-encrypt command will create the security/metricshub-keystore.p12 file to store a unique and random master password. This master password is used to encrypt passwords with metricshub-encrypt, and decrypt them from config/YOUR_CONFIGURATION_FILE.

The metricshub-keystore.p12 file must not be modified, as this would prevent decryption from working. Any password encrypted with a given metricshub-keystore.p12 master password must be decrypted with the exact same metricshub-keystore.p12 file.

The metricshub-keystore.p12 file can be shared across several hosts so that a password encrypted on one system can be decrypted on another. Simply copy the metricshub-keystore.p12 file to the security directory. This will make MetricsHub able to decrypt the passwords.

Note: On Windows, the security directory is located under the ProgramData\MetricsHub directory (C:\ProgramData\MetricsHub\security) and accessible to Administrators only. On Linux, the security directory is located under the installation directory (/opt/metricshub/security).