Chat now with support
Chat with Support

One Identity Safeguard for Privileged Passwords 6.7 - 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 Search box Privileged access requests Toolbox Accounts Account Groups Assets Asset Groups Discovery Entitlements Partitions Settings
Access Request settings Appliance settings Asset Management settings Backup and Retention settings Certificates settings Cluster settings Enable or Disable Services settings External Integration settings Messaging settings (desktop client) Password Management settings Safeguard Access settings SSH Key Management 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 SPP Glossary About us

Adding identity and authentication providers

It is the responsibility of the Asset Administrator to add directories to Safeguard for use as identity and authentication providers.

If Active Directory forests have more than one domain, select the domain to use for identity and authentication and to display on the logon screen. It is the responsibility of a User Administrator or Appliance Administrator to create an External Federation or Radius provider to use for authentication.

To add identity and authentication providers

  1. Go to Identity and Authentication:
    • web client: Navigate to  Settings | Safeguard Access | Identity and Authentication.
    • desktop client: Navigate to Administrative Tools | Settings | External Integration | Identity and Authentication.
  2. Click Add.
  3. Click the provider:
Active Directory and LDAP settings

Use the General tab to add the required service account information. The following table lists the properties and designates the properties for Active Directory or LDAP only, if applicable.

Table 184: Active Directory and LDAP: General tab properties
Property Description

Product

web client

The product name such as: Active Directory or OpenLDAP 2.4.

Forest Root Domain Name

web client

Forest Root Domain Name.

Name

Unique name.

Service Account Domain Name (for Active Directory)  

Enter the fully qualified Active Directory domain name, such as example.com.

Do not enter the domain controller hostname, such as server.example.com; the domain controller's IP address, such as 10.10.10.10; or the NETBIOS domain name, such as EXAMPLE.

The service account domain name is the name of the domain where the service account resides. Safeguard for Privileged Passwords uses DNS-SRV to resolve domain names to actual domain controllers.

Network Address

(for OpenLDAP)

Enter a network DNS name or the IP address of the LDAP server for Safeguard for Privileged Passwords to use to connect to the managed system over the network.

Service Account Name (for Active Directory)

Enter an account for Safeguard for Privileged Passwords to use for management tasks. If the account name matches an account name already linked to an identity provider, the provider is automatically assigned.

When you add the directory, Safeguard for Privileged Passwords automatically adds the service account to the directory's Accounts tab and disables it for access requests. If you want the password to be available for release, click Access Requests and select Enable Password Request from the details toolbar. To enable session access, select Enable Session Request.

Add an account that has permission to read all of the domains and accounts that you want to manage with Safeguard for Privileged Passwords.

Safeguard for Privileged Passwords is forest-aware. Using the service account you specify, Safeguard for Privileged Passwords automatically locates all of the domains in the forest and creates a directory object that represents the entire forest. The directory object will have the same name as the forest-root domain regardless of which account you specify.

For more information, see About service accounts.

Service Account Distinguished Name (for OpenLDAP)

Enter a fully qualified distinguished name (FQDN) for Safeguard for Privileged Passwords to use for management tasks. For example: cn=dev-sa,ou=people,dc=example,dc=com

Service Account Password

Enter the password Safeguard for Privileged Passwords uses to authenticate to this directory.

Description

Enter information about this external identity provider.

Connect

Click Connect to verify the credentials. If adding an Active Directory provider, all domains in the forest will be displayed. Choose which ones can be used for identity and authentication.

Available Domains for Identity and Authentication (for Active Directory)

All newly created Safeguard users that are imported from the directory user group will have their primary authentication provider set to use the directory domain from which their user originates. For an Active Directory forest with multiple domains, the domains must be marked as Available Domains for Identity and Authentication. Clearing the forest root domain will have undesired results when managing directory users and groups. For more information, see Adding a directory user group.

Advanced Open to reveal the following synchronization settings:
Port (for LDAP)

Enter port 389 used for communication with the LDAP directory.

Domain Controllers

(for Active Directory)

Instead of having Safeguard for Privileged Passwords automatically find domain controllers from a DNS and CLDAP ping, you can specify domain controllers.

In the desktop client, select Specify domain controllers.

In the text box, enter the network addresses, which may be DNS names or IP addresses, separated by spaces, commas, or semicolons. If you have multi-domains, you must provide a domain controller for every domain. Do not enter the domain itself.

The domain controllers are used in the order entered. During the test connection from the Connection tab, if SPP does not find a domain controller in the list, the test connection fails and an error is returned.

Adding a read-only domain controller will be limited in functionality. For example, login will work but password or SSH key check and change will not work.

During a process, if one domain controller does not respond, the processes continue with the next domain controller. The non-responsive domain controller is blacklisted for about 5 minutes.

Sync additions every

Enter or select how often you want Safeguard for Privileged Passwords to synchronize directory additions (in minutes). This updates Safeguard for Privileged Passwords with any additions, or modifications that have been made to the directory objects, including group membership and user account attributes mapped to Safeguard for Privileged Passwords.

Default: 15 minutes

Range: Between 1 and 2147483647

Sync deletions every

Enter or select how often you want Safeguard for Privileged Passwords to synchronize directory deletions (in minutes). This updates Safeguard for Privileged Passwords with any deletions that have been made to the directory objects, including group membership and user account attributes mapped to Safeguard for Privileged Passwords.

Default: 15 minutes

Range: Between 1 and 2147483647

Attributes tab

On the Attributes tab, synchronize the attributes in Safeguard for Privileged Passwords to the directory schema attributes. The Attributes tab displays the default directory attributes that are mapped to the Safeguard for Privileged Passwords properties, such as the user's first name.

There are multiple valid schema mappings supported and you can modify its configuration, as needed. For example, the LDAP dialog, Attributes tab may display the Username as the cn <Display Name> or the uid <Username> based on your directory configuration.

To map the Safeguard for Privileged Passwords properties to different directory attributes

  1. Browse to select one or more object classes for the users, computers, and groups categories, as applicable.

    Note: You can use or remove the default object class.

  2. If you do not want to use the default property, begin typing in the property box. Safeguard for Privileged Passwords' auto-complete feature immediately displays a list of attributes to choose. Safeguard for Privileged Passwords only allows you to select attributes that are valid for the object classes you have selected for users, groups, and computers.
  3. Once you have set all the properties, click Apply.

The following table list the default directory attributes.

Table 185: Active Directory and LDAP: Attributes tab (defaults)
Safeguard for Privileged Passwords attribute Directory attribute

 

Users

 

Object Class

Browse to select a class definition that defines the valid attributes for the user object class.

Default: user for Active Directory, inetOrgPerson for LDAP

 

User Name

sAMAccountName for Active Directory, cn for LDAP

 

Password

userPassword for LDAP

 

First Name

givenName

 

Last Name

sn

 

Work Phone

telephoneNumber

 

Mobile Phone

mobile

 

Email

mail

 

Description

description

 

External Federation Authentication

The directory attribute used to match the email address claim or name claim value from the SAML Response of an external federation authentication request. Typically, this will be an attribute containing the user’s email address or other unique identifier used by the external Secure Token Service (STS).

For both Active Directory and OpenLDAP 2.4, this will default to the "mail" attribute.

This is only used when processing members of a directory user group in which the group has been configured to use an External Federation provider as the primary authentication.

For more information, see Adding a directory user group.

 

Radius Authentication

The directory attributed used to match the username value in an external Radius server that has been configured for either primary or secondary authentication.

For Active Directory, this will default to using the samAccountName attribute. For OpenLDAP 2.4, this will default to using the cn attribute.

NOTE: This is only used when processing members of a directory user group in which the group has been configured to use Radius as either the primary or secondary authentication provider.

For more information, see Adding a directory user group.

 

Managed Objects

The directory attribute used when automatically associating existing managed Accounts to users of a directory user group as linked accounts.

Defaults:

  • For Active Directory, this defaults to managedObjects. However, you may want to use the directReports attribute based on where you have the information stored in Active Directory.
  • For OpenLDAP 2.4, this defaults to the seeAlso attribute.

When choosing an attribute, it must exist on the user itself and contain one or more Distinguished Name values of other directory user objects. For example, you would not want to use the owner attribute in OpenLDAP 2.4, as the direction of the relationship is going the wrong way. You would instead want an owns attribute to exist on the user such as the default seeAlso attribute.

For more information, see Adding a directory user group.

 

Groups

 

 

Object Class

Browse to select a class definition that defines the valid attributes for the group object class.

Default: group for Active Directory, groupOfNames for LDAP

 

Name

sAMAccountName for Active Directory, cn for LDAP

 

Member

member

 

Description

description

 

External Federation settings

One Identity Safeguard for Privileged Passwords supports the SAML 2.0 Web Browser SSO Profile, allowing you to configure federated authentication with many different STS servers and services, such as Microsoft's AD FS. Through the exchange of the federation metadata, you can create a trust relationship between the two systems. Then, you will create a Safeguard for Privileged Passwords user account to be associated with the federated account. When an end user logs in, they will be redirected to the external STS to enter their credentials and perform any two-factor authentication that may be required by that STS. After successful authentication, they will be redirected back to Safeguard for Privileged Passwords and logged in.

NOTE: Additional two-factor authentication can be assigned to the associated Safeguard for Privileged Passwords user account to force the user to authenticate again after being redirected back from the external STS.

To use external federation, you must first download the federation metadata XML for your STS and save it to a file. For example, for Microsoft's AD FS, you can download the federation metadata XML from:

https://<adfs server>/FederationMetadata/2007-06/FederationMetadata.xml.

To add external federation:

  1. In the External Federation dialog, supply the following information:
    1. Name: The unique name assigned to the external federation service provider. The name is for administrative purposes only and will not be seen by the end users.

    2. Description: Enter any text. The text is seen only here and used for administrative purposes.

    3. Realm: The unique realm value (typically a DNS suffix, like contoso.com) that matches the email addresses of users that will use this STS for authentication. A case-insensitive comparison will be used on this value when performing Home Realm Discovery.
    4. Federation Metadata File: Click Browse to select the STS federation metadata xml file.
  2. Click Download Safeguard for Privileged Passwords Metadata File: You will need this file to create the corresponding trust relationship on your STS server. The federation metadata XML file typically contains a digital signature and cannot be modified in any way, including white space. If you receive an error regarding a problem with the metadata, ensure the file has not been edited. Also see: How do I create a relying party trust for the STS.
Radius settings

Create and configure a Radius server for use as either a primary authentication provider or secondary authentication provider. To use a Radius server for both primary and secondary authentication, you will need to create two authentication providers. The steps to create Radius as a primary provider or secondary provider follow:

  1. In the Radius dialog, supply the following information:
    1. Name: The unique display name. When creating the Radius provider for primary authentication, this name value will be displayed in the drop-down list on the login page.

    2. Description: Enter any text. The text is seen only here and used for administrative purposes.
    3. Type: Choose As Primary Authentication or As Secondary Authentication.

    4. Server Address: Enter a network DNS name or the IP address used to connect to the server over the network.
    5. Secondary Server Address: (Optional) Enter a network DNS name or the IP address for an additional or redundant server.
    6. Shared Secret: Enter the server's secret key. Click to show the server's secret key.
    7. Port: Enter the port number that the Radius server uses to listen for authentication requests. The default is port 1812.
    8. Timeout: Specify how long to wait before a Radius authentication request times out. The default is 20 seconds.
    9. PreAuthenticate for Challenge/Response: If selected, an Access-Request call containing only the User-Name is sent to the Radius server prior to the user's authentication attempt. This is done to inform the Radius server of the user's identity so it can possibly begin the authentication process by starting a challenge/response cycle. This may be required to seed the user's state data. In addition, the Radius server's response may include a login message that is to be displayed, which is specific to that user.

      If the Radius server is not configured to respond with an Access-Challenge, then this will cause the log in to fail and the user will be unable to proceed. This setting is only applicable when using Radius as a secondary authentication provider. The setting has no effect if enabled on a primary authentication provider.

    10. Always Mask User Input: If selected, the text box that the user enters their one-time password, or other challenge required by the Radius server, will always be a password style text box in which the user's input is masked and appears as a series of dots, not as clear text. This may be desired when the challenge is not only a one-time password, but also contains the user's PIN. This will prevent any passer-by from seeing the private information. Note, however, that when this setting is enabled, it will also override the Prompt attribute of the Radius server's Access-Challenge response, such that the user's input will always be masked.
  2. Click OK.

NOTE: When Safeguard for Privileged Passwords attempts to authenticate a user against the Radius server, it will always include the NAS-Identifier Radius attribute with a value set to the appliance ID. There is no setting to turn this on or off, nor specify a custom value.

FIDO2 settings

Create and configure FIDO2 for use as a secondary authentication provider.

  1. In the FIDO2 dialog, provide the following settings:
    1. Name: The unique name assigned to the provider. The name is for administrative purposes only and will not be seen by the end users.
    2. Domain Suffix: This must be a DNS name that identifies the appliance. Typically, this will be the DNS name used to access Safeguard. It cannot be an IP address. The value is a a domain string identifying the WebAuthn Relying Party for which the registration or authentication ceremony is performed.

      A public key credential can only be used for authentication with the same entity (identified by this value) it was registered with. However, this value can be a registerable domain suffix of what appears in the user’s browser when registering. For example, you could enter contoso.com to register against a server at https://www.contoso.com or https://node1.contoso.com. Later, you can use the same authenticator security key to authenticate at either of the locations.

    3. Description: Enter any text. The text is seen only here and used for administrative purposes.
  2. Click OK.

SSH Key Management settings

desktop client only

SSH authorization keys are managed to maximize security over automated processes as well as sign-on by system administrators, power users, and others who use SSH keys for access. Safeguard for Privileged Passwords (SPP) performs the following.

  • SPP provisions keys by creating a new key pair associated with a managed account. Any of the following methods can be used.
    • An authorized key is added in the target account on the target host. A managed account can have more than one authorized key.
    • An SSH key sync group is created for an SSH key pair. The new key is generated for the sync group and configured for each of the synced accounts on the target host. All accounts in the SSH key sync group synchronize with the new passphrase so the same key can be used to log into all systems.
    • A legacy SSH identity key is uploaded. The legacy SSH key is entrusted to SPP. When legacy SSH keys are exposed, SPP rotates them after they are checked in.
  • SPP requests and rotates SSH keys based on the access request policy (key and session) as well as via A2A when A2A is configured to request and retrieve SSH keys. Rotation is profile-based. Each managed account can have a single SSH key.
Supported implementations

SSH implementations supported include:

  • Access requests provide SSH identity keys include OpenSSH, SSH2, and PuTTY format.
  • For management, SPP supports OpenSSH file formats and Tectia
Supported key types and key lengths

SPP supports RSA and DSA algorithms for SSH identity keys. Supported key lengths follow:

  • RSA: 1024, 2048, 4096, and 8192-bit

    Larger key sizes take longer to generate. In particular, a key size of 8192-bits may take several minutes.

  • DSA: fixed to 1024-bits
Unsupported algorithms and key strings

SPP reads each line when parsing an authorized_keys file and attempts to extract the data. If a line is properly formatted according to the specification, SPP will report it as a discovered identity key. SPP recognizes keys with either the RSA or DSA algorithm. Other valid key types are still discovered by SPP and are identified as the Key Type of Unknown on the Discovered SSH Keys properties grid.

If a line is not properly formatted, the data will be skipped and a warning with the number of invalid lines will be included on the Toolbox | Task pane. Further details, including a copy of each invalid line, displays on the Operations tab. For more information, see Viewing task status.

Management

It is the responsibility of the Appliance Administrator to manage the access request and SSH key passphrase management services.

SSH key change, check, and discovery can be toggled on or off. For more information, see Enable or disable access request and services.

Navigate to Administrative Tools | Settings | SSH Key Management.

Table 186: SSH Key Management settings
Setting Description
Change SSH Key settings You can add, update, or remove SSH key change settings.
Check SSH Key settings You can add, update, or remove SSH key check settings.

Discover SSH Key settings

You can discover authorized SSH keys in managed accounts.

SSH Key Sync Groups settings

The Asset Administrator or a partition's delegated administrator defines the SSH key sync group for an SSH key pair. The new key is generated for the sync group and configured for each of the synced accounts on the target host. All accounts in the SSH key sync group synchronize so the same key can be used to log into all systems.

Change SSH Key settings

desktop client only

Safeguard for Privileged Passwords requests and rotates SSH keys based on the access request policy (key and session) as well as via A2A configurations set up to request and retrieve SSH keys. Rotation is profile-based. Each managed account can have a single SSH key.

SSH key change can be toggled on or off. For more information, see Enable or disable access request and services.

Navigate to Administrative Tools | Settings | SSH Key Management | Change SSH Key.

Table 187: Change SSH Key properties
Setting Description

Name

The name of the SSH key

Partition

The partition where the SSH key is managed

Description

Information about the SSH key

Schedule

Designates when the SSH key is changed

Use the following toolbar buttons to manage changing the SSH key.

Table 188: Change SSH Key: Toolbar
Option Description
Add

Add SSH key change settings. For more information, see Adding SSH key change settings.

Delete Selected

Permanently remove the selected SSH key.

Refresh

Update the list of SSH keys.

Edit Modify the selected SSH key.

Copy SSH Key

Copy the SSH key settings.

Search

To locate a value in this list, enter the character string to be used to search for a match. For more information, see Search box.

Adding SSH key change settings

desktop client only

It is the responsibility of the Asset Administrator or the partition's delegated administrator to configure the rules Safeguard for Privileged Passwords uses to reset SSH key passphrases.

IMPORTANT: Passphrases for accounts associated with an SSH key sync group are managed based on the profile change schedule and processed via the SSH key sync group. If synchronization fails for an individual account in the sync group, the account is retried multiple times and, if failing after that, the sync task halts and is rescheduled. The administrator must correct the cause of the failure for the sync task to continue. For more information, see SSH Key Sync Groups settings.

To add an SSH key reset schedule

  1. Navigate to Administrative Tools | Settings | SSH Key Management | Change SSH Key.
  2. Click  Add to open the Change SSH Key Settings dialog.
  3. Browse to select a partition.
  4. Enter a Name of up to 50 characters for the rule.
  5. Enter a Description of up to 255 characters for the rule.
  6. Enter a Comment.
  7. Select a Key Length such as 1024, 2048, 4096, or 8192 characters. Larger key sizes take longer to generate. In particular, a key size of 8192-bits may take several minutes.
  8. Optionally, select Change SSH Keys Manually.

    For more information, see How do I manage accounts on unsupported platforms.

  9. To change the Change SSH Key schedule, click the link or click the Schedule button. The default is Never.
  10. In the Schedule dialog, select Run Every to run the job along per the run details you enter. (If you deselect Run Every, the schedule details are lost.)

    • Configure the following.

      To specify the frequency without start and end times, select from the following controls. If you want to specify start and end times, go to the Use Time Window selection in this section.

      Enter a frequency for Backup Every. Then, select a the time frame:

      • Minutes: The job runs per the frequency of minutes you specify. For example, Every 30 Minutes runs the job every half hour over a 24-hour period. It is recommended you do not use the frequency of minutes except in unusual situations, such as testing.
      • Hours: The job runs per the minute setting you specify. For example, if it is 9 a.m. and you want to run the job every two hours at 15 minutes past the hour starting at 9:15 a.m., select Runs Every 2 Hours @ 15 minutes after the hour.

      • Days: The job runs on the frequency of days and the time you enter.

        For example, Every 2 Days Starting @ 11:59:00 PM runs the job every other evening just before midnight.

      • Weeks The job runs per the frequency of weeks at the time and on the days you specify.

        For example, Every 2 Weeks Starting @ 5:00:00 AM and Repeat on these days with MON, WED, FRI selected runs the job every other week at 5 a.m. on Monday, Wednesday, and Friday.

      • Months: The job runs on the frequency of months at the time and on the day you specify.

        For example, If you select Every 2 Months Starting @ 1:00:00 AM along with First Saturday of the month, the job will run at 1 a.m. on the first Saturday of every other month.

    • Select Use Time Windows if you want to enter the Start and End time. You can click Add or Remove to control multiple time restrictions. Each time window must be at least one minute apart and not overlap.

      For example, for a job to run every ten minutes every day from 10 p.m. to 2 a.m., enter these values:

      Enter Every 10 Minutes and Use Time Windows:

      • Start 10:00:00 PM and End 11:59:00 AM
      • Start 12:00:00 AM and End 2:00:00 AM

        An entry of Start 10:00:00 PM and End 2:00:00 AM will result in an error that the end time must be after the start time.

      If you have selected Days, Weeks, or Months, you will be able to select the number of times for the job to Repeat in the time window you enter.

      For a job to run two times every other day at 10:30 am between the hours of 4 a.m. and 8 p.m., enter these values:

      For days, enter Every 2 Days and set the Use Time Windows as Start 4:00:00 AM and End 20:00:00 PM and Repeat 2.

    • (UTC) Coordinated Universal Time is the default time zone. Select a new time zone, if desired.

    If the scheduler is unable to complete a task within the scheduled interval, when it finishes execution of the task, it is rescheduled for the next immediate interval.

  11. Optionally, select Suspend account when checked in (supported platforms): Select this option to automatically suspend managed accounts that are not in use. That is, the account on a managed asset is suspended until a request is made for it through Safeguard for Privileged Passwords, at which time Safeguard for Privileged Passwords restores the account. Once the request is checked in or closed, the account is again suspended.
    You can click the supported platforms link to display a list of platforms that support this feature (KB Article 233379).
  12. Click OK.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating