Chat now with support
Chat with Support

Safeguard for Privileged Passwords On Demand Hosted - Administration Guide

Introduction System requirements and versions Using API and PowerShell tools Using the virtual appliance and web management console Cloud deployment considerations Setting up Safeguard for Privileged Passwords for the first time Using the web client Getting started with the desktop client Using the desktop client Activity Center Search box Privileged access requests Toolbox Accounts Account Groups Assets
General/Properties tab (asset) Accounts tab (asset) Account Dependencies tab (asset) Owners tab (asset) Access Request Policies tab (asset) Asset Groups tab (asset) Discovered SSH Keys (asset) Discovered Services tab (asset) History tab (asset) Managing assets
Asset Groups Discovery Entitlements Linked Accounts Partitions Profiles Settings
Access Request settings Appliance settings Asset Management settings Tags Backup and Retention settings Certificates settings Cluster settings Enable or Disable Services settings External Integration settings Password Management settings Real-Time Reports Safeguard Access settings SSH Key Management settings Security Policy Settings
Users User Groups Disaster recovery and clusters Administrator permissions Preparing systems for management Troubleshooting Frequently asked questions Appendix A: Safeguard ports Appendix B: SPP 2.7 or later migration guidance Appendix C: SPP and SPS join guidance Appendix D: Regular Expressions About us

Enabling email notifications

For users to receive email notifications, there are a few things you must configure properly.

To enable email notifications

  1. Users must set up their email address correctly.
    1. Local users:
      1. The Authorizer Administrator or User Administrator sets this up in the user's Contact Information. For more information, see Adding a user.

        -OR-

      2. Users set this up in their My Account settings. For more information, see User information and log out (desktop client).
    2. Directory users must have their email set in the Active Directory or LDAP domain.
  2. The Appliance Administrator must configure the SMTP server. For more information, see Email.

TIP: You can setup email subscriptions to any email event type through the API: https://<Appliance IP>/service/core/swagger/ui/index#/EventSubscribers. For more information, see Using the API.

Email Templates

Safeguard for Privileged Passwords provides default email templates for most events, such as Cluster Primary Quorum Fails or Access Request Denied. Each event type triggers an email notification that uses the template.

Go to Email Templates:

  • web client: Navigate to External Integration | Email Templates.
  • desktop client: Navigate to Administrative Tools | Settings | External Integration | Email then scroll to the Email Templates section.

Use these toolbar buttons to manage email templates.

Table 212: Email template: Toolbar
Property Description

Reset

Reset the selected template to the default.

Edit

Modify the selected email template.

Refresh

Update the list of email templates.

Search

To locate a specific template, enter the character string to be used to search for a match. For more information, see Search box.

Macro properties

Each event type supports specific macros in the template that are appropriate for that type of event. When editing a template, you can click Insert Event Property to select properties to insert into the text of the Subject line or Body using keywords surrounded by double braces. For example, you may select the following event properties in the Subject of your email:

Access Policy Created {{EventDescription}} {{PolicyId}}

Safeguard for Privileged Passwords ignores macros that are not supported by the event type. Unsupported macros appear blank in the email preview. Additionally, a warning message like the following may displays: Invalid format for BodyTemplate property.

To edit an email template

Modify an email template to change any information except the Event type. If you later want to revert to the original template, you can select the template then click Reset . To modify an email template, use the following steps.

  1. Go to Email Templates:
    • web client: Navigate to External Integration | Email Templates.
    • desktop client: Navigate to Administrative Tools | Settings | External Integration | Email and scroll to the Email Templates section.
  2. In the Email Template grid, select the template to modify and click. Edit.

    1. Event: For more information, see Enabling email notifications.

    2. Subject: Edit the subject line for the email message.

      As you type, click  Insert Event Property Macro to insert predefined text into the subject line. For example, you may create the following subject line:

      Approval is required for {{Requester}}'s request

      where Safeguard for Privileged Passwords generates the data defined by the macro within the double braces.

      Limit: 1024 characters

    3. Reply to: Enter the email address of the person to reply to concerning this notification.

      Limit: 512 characters

    4. Body: Enter the body of the message.

      As you type, click  Insert Event Property Macro to insert predefined text into the body. For example, you may create the following body for an email template:

      {{Requester}} has requested the password for {{AccountName}} on {{AssetName}}

      where Safeguard for Privileged Passwords generates the data defined by the macro within the double braces.

      Limit: 16384 characters

    5. Preview Email: Select this link to display the Preview Email dialog so you can see how your email message will look.
    6. Click OK. The updated template is added to the Email Template grid.
  3. If you want to return to the default, select the email template then click Reset.

To add an email template

desktop client only

You can add individual email templates, for example to provide notification when emergency access is granted

Add an email template if you want to keep the original template and simply create an additional template for the Event.

  1. Navigate to Administrative Tools | Settings | External Integration | Email and scroll to the Email Templates section.

  2. In the Email Template grid, click Add. It doesn't matter what template is selected.

    1. Select the Event. The default may be different than the template selected. An additional template for the event type will be added.

    2. Enter or select a Subject. You can click to add an event property.
    3. Enter a Reply To.
    4. Enter the Body content. You can click to add an event property.
    5. Click Preview Email to see what will be sent.

    6. Click OK. The template is added to the Email Template grid.

  3. If you want to return to the default, select the email template then click Reset.

Hardware Security Module

It is the responsibility of the Appliance Administrator to configure Safeguard for Privileged Passwords to integrate with an external Hardware Security Module for encryption.

Use the Hardware Security Module pane to configure the Hardware Security Module integration. The following Hardware Security Modules are supported:

  • Thales Luna 7.X

  • Thales Luna 6.X

  • Thales Data Protection on Demand

Go to Hardware Security Module:

  • web client: Navigate to Appliance Management | External Integration | Hardware Security Module.
Before you start

Before configuring the Hardware Security Module integration, the Thales Luna environment needs to be fully installed and configured. This includes but is not limited to:

  • Setting the Crypto Officer password.

  • Generating the Hardware Security Module server certificate(s) (network Luna only).

  • Generating a Hardware Security Module client certificate for each Safeguard for Privileged Password clustered appliance (network Luna only).

  • Initializing a partition.

  • Creating any high availability groups Safeguard for Privileged Passwords will utilize.

Safeguard for Privileged Passwords will require the following information to configure the integration:

  • Crypto Officer password

  • Server certificate(s) (network Luna only)

  • Client certificate(s) (network Luna only)

  • Partition label (can be high availability group label)

  • crystoki.ini file

If you are configuring an integration that includes a network Luna device, first install and assign the Hardware Security Module client and server certificates for your environment. For more information, see Installing a Hardware Security Module client certificate, Assigning a Hardware Security Module client certificate, and Uploading a Hardware Security Module server certificate.

IMPORTANT: Connection to network Luna devices is only supported through a Network Trust Links (NTLs) connection. Secure Trusted Channel (STC) connections are not supported when integrating with Safeguard for Privileged Passwords.

CAUTION: It is best practice to only enable or disable a Hardware Security Module integration on a standalone Safeguard for Privileged Passwords appliance. The encrypted data stored within the Safeguard for Privileged Passwords appliance will be re-encrypted during these operations. If enabling or disabling in a clustered environment, the cluster will be broken and the primary Safeguard for Privileged Passwords appliance will be set to a standalone appliance and all replica’s will need to be rejoined to the cluster after the maintenance task has been completed. During this time ensure that no operations that use encrypted data, such as password check and change are performed on the replica appliances to avoid data corruption.

CAUTION: Safeguard for Privileged Passwords will use a reserved label for the encryption key stored on the Hardware Security Module partition. These labels cannot exist on the partition when doing an integration for the first time. The reserved key label name is:

SafeguardMasterKey1

CAUTION: When configuring an integration that includes network Luna devices, ensure all client and server certificates have been installed on the primary Safeguard for Privileged Passwords appliance for all future cluster members. In addition, install and assign the required client certificates on the replicas prior to joining the cluster.

To configure the Hardware Security Module integration

  1. Go to Hardware Security Module:

    • web client: Navigate to Appliance Management | External Integration | Hardware Security Module.

  2. Select the Use External HSM checkbox.

  3. In the Partition Label field, enter the partitional label Safeguard for Privileged Passwords should use on the Hardware Security Module device.

  4. Enter the Crypto Officer password Safeguard for Privileged Passwords should use to connect to the Hardware Security Module device.

  5. Click Upload File and browse for the crystoki.ini configuration file.

  6. Once selected, click Open.

  7. Click Save.

    NOTE: If there is an error with Safeguard for Privileged Passwords ability to move forward with the integration based on the provided configuration, a message displays in the user interface with further information.

Once you have finished configuring the Hardware Security Module integration, the following information and options will be available:

Table 213: Hardware Security Module: Properties
Setting Description

Health Status

Displays the results of the last Hardware Security Module verification.

Refresh

Runs a Hardware Security Module verification. This can be used to transition a Safeguard for Privileged Passwords appliance out of the HardwareSecurityModuleError state.

Last Successful Access Date

The date and time of the last Healthy Hardware Security Module status.

Show Details

Shows the current crystoki.ini contents being used for the Hardware Security Module integration.

To disable the Hardware Security Module integration

  1. Go to Hardware Security Module:

    • web client: Navigate to Appliance Management | External Integration | Hardware Security Module.

  2. Deselect the Use External HSM checkbox.

  3. Click Save.

SNMP

Simple Network Management Protocol (SNMP) is an Internet-standard protocol for managing devices on IP networks. One Identity Safeguard for Privileged Passwords allows you to configure SNMP subscriptions for sending SNMP traps to your SNMP console when certain events occur.

Go to SNMP:

  • web client: Navigate to External Integration | SNMP.
  • desktop client: Navigate to Administrative Tools | Settings | External Integration | SNMP.

The SNMP pane displays the following about the SNMP subscribers defined.

Table 214: SNMP: Properties
Property Description
Network Address The IP address or FQDN of the primary SNMP network server
Port The UDP port number for SNMP traps
Version The SNMP version being used
Community The SNMP community string being used by the SNMP subscriber
Description The description of the SNMP subscriber
# of Events The number of events selected to be sent to the SNMP console

Use these toolbar buttons to manage the SNMP subscriptions.

Table 215: SNMP: Toolbar
Option Description
Add Add a new SNMP subscription. For more information, see Configuring SNMP subscriptions.
Remove

Remove the selected SNMP subscription.

Edit Modify the selected SNMP subscription.
Copy Clone the selected SNMP subscription.
Refresh Update the list of SNMP subscriptions.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating