18.4.1. Procedure – Configuring local Credential Stores

Purpose: 

To configure a local Credential Store that stores the credentials used to login to the target host, complete the following steps.

Prerequisites: 

Note

Users accessing connections that use Credential Stores to authenticate on the target server must authenticate on PSM using gateway authentication or an AA plugin. Therefore gateway authentication or an AA plugin must be configured for these connections. For details, see Section 18.2, Configuring gateway authentication and Section 18.5, Integrating external authentication and authorization systems.

Steps: 

  1. Navigate to Policies > Credential Stores.

  2. Click and enter a name for the Credential Store.

  3. Select Local.

  4. Select Encryption key > Built-in. That way the credentials will be encrypted with a built-in password, and the Credential Store is automatically accessible when PSM boots up. To use custom passwords to encrypt the Credential Store, see Procedure 18.4.3, Configuring password-protected Credential Stores.

    Figure 18.12. Policies > Credential Stores > Local — Configuring local Credential Stores

    Policies > Credential Stores > Local — Configuring local Credential Stores
  5. Add credentials to the Credential Store.

    1. Click and enter the destination host and the username. For the destination host, you can use hostname, IP address, or subnet as well. To use the same credentials for every destination host, enter the 0.0.0.0/0 subnet. To use the credentials only on the hosts of a specific domain, enter *.domain. Note that:

      • Usernames are case sensitive.

      • To authenticate users of a Windows domain, enter the name of the domain into the Host field.

      Use an IPv4 address.

    2. Set the credentials. PSM will use these credentials to login to the destination host if the credential store is selected in a Connection policy. If more than one credential is specified to a host-username pair, PSM will attempt to use the credentials as the destination host requests it.

      • To add a password, click Passwords > , then enter the password corresponding to the username.

      • To upload a private key, click SSH Keys > > , then paste or upload a private key.

        Note

        If the private key is protected by a passphrase, enter the passphrase. The passphrase is needed only once during the upload, it is not required for the later operation of the Credential Store.

      • To generate a keypair on PSM click SSH Keys > > , set the length and type of the key, then click Generate. After that, click the fingerprint of the key to download the public part of the keypair. There is no way to download the private key from the PSM web interface.

        Note

        Balabit recommends using 2048-bit RSA keys (or stronger).

      • To upload a certificate and the corresponding private key, click X509 Keys > > , then paste or upload a certificate and the private key.

        Note

        If the private key is protected by a passphrase, enter the passphrase. The passphrase is needed only once during the upload, it is not required for the later operation of the Credential Store.

      Note

      PSM accepts passwords that are not longer than 150 characters. The following special characters can be used: !"#$%&'()*+,-./:;<=>?@[\]^-`{|}

    3. Repeat the previous step to add further credentials to the username as necessary.

  6. Repeat the previous step to add further hosts or usernames as necessary.

    Note

    Credential Stores can be used together with usermapping policies to simplify the administration of users on the target hosts. For details, see Procedure 18.1, Configuring usermapping policies.

  7. Click .

  8. Navigate to the Connection policy where you want to use the Credential Store (for example, to SSH Control > Connections), select the Credential Store to use in the Credential Store field, then click .

    Note

    The Connection Policy will ignore the settings for server-side authentication (set under Relayed authentication methods) if a Credential Store is used in the Connection Policy.

    Figure 18.13. <Protocol name> Control > Connections — Select a Credential Store to use

    <Protocol name> Control > Connections — Select a Credential Store to use