Managing shared scan credentials

You can create and manage scan credentials that can be used in multiple sites. Using shared credentials can save time if you need to perform authenticated scans on a high number of assets in multiple sites that require the same credentials. It’s also helpful if these credentials change often. For example, your organization’s security policy may require a set of credentials to change every 90 days. You can edit that set in one place every 90 days and apply the changes to every site where those credentials are used. This eliminates the need to change the credentials in every site every 90 days.

To configure shared credentials, you must have a Global Administrator role or a custom role with Manage Site permissions.

To learn the differences between shared and site-specific credentials, review Shared Credentials vs. Site Specific Credentials .

Creating a set of shared scan credentials

Creating a set of shared scan credentials includes the following actions:

After you create a set of shared scan credentials you can take the following actions to manage them:

Naming and describing the new set of shared credentials

Think of a name and description that will help Site Owners recognize at a glance which assets the credentials will be used for.

Click the Administration tab.
In the Scans > Shared Credentials section, click Manage.
Click New.
Enter a name for the new set of credentials.
Enter a description for the new set of credentials.
Continue with configuring the account, as described in the next section.

Configuring the account for authentication

Configuring the account involves selecting an authentication method or service and providing all settings that are required for authentication, such as a user name and password.

If you do not know what authentication service to select or what credentials to use for that service, consult your network administrator.

Go to the Account page of the Shared Scan Credentials Configuration panel.
Select an authentication service or method from the drop-down list.
Enter all requested information in the appropriate text fields.
If you want to test the credentials or restrict them see the following two sections. Otherwise, click Save.

Testing shared scan credentials

You can verify that a target asset will authenticate a Scan Engine with the credentials you’ve entered. It is a quick method to ensure that the credentials are correct before you run the scan.

For shared scan credentials, a successful authentication test on a single asset does not guarantee successful authentication on all sites that use the credentials.

Go to the Account page of the Credentials Configuration panel.
Expand the Test Credentials section.
Select the Scan Engine with which you will perform the test.
Enter the name or IP address of the authenticating asset.
To test authentication on a single port, enter a port number.
Click Test credentials.

Note the result of the test. If it was not successful, review and change your entries as necessary, and test them again.

Upon seeing a successful test result, configure any other settings as desired.
If you want to restrict the credentials to a specific asset or port, see the following section. Otherwise, click Save.

Restricting the credentials to a single asset and port

If a particular set of credentials is only intended for a specific asset and/or port, you can restrict the use of the credentials accordingly. Doing so can prevent scans from running unnecessarily longer due to authentication attempts on assets that don’t recognize the credentials.

If you restrict credentials to a specific asset and/or port, they will not be used on other assets or ports.

Specifying a port allows you to limit your range of scanned ports in certain situations. For example, you may want to scan Web applications using HTTP credentials. To avoid scanning all Web services within a site, you can specify only those assets with a specific port.

Go to the Restrictions page of the Shared Scan Credentials Configuration panel.
Enter the host name or IP address of the asset that you want to restrict the credentials to. OR Enter host name or IP address of the asset and the number of the port that you want to restrict the credentials to.
When you have finished configuring the set of credentials, click Save.

Assigning shared credentials to sites

You can assign a set of shared credentials to one or more sites. Doing so makes them appear in lists of available credentials for those site configurations. Site Owners still have to enable the credentials in the site configurations. See Configuring scan credentials.

To assign shared credentials to sites, take the following steps:

Go to the Site assignment page of the Shared Scan Credentials Configuration panel.
Select one of the following assignment options:

Assign the credentials to all current and future sites
Create a custom list of sites that can use these credentials

If you select the latter option, the Security Console displays a button for selecting sites.

Click Select Sites. The Security Console displays a table of sites.
Select the check box for each desired site, or select the check box in the top row for all sites. Then click Add sites. The selected sites appear on the Site Assignment page.
Configure any other settings as desired. When you have finished configuring the set of credentials, click Save.

Viewing shared credentials

Click the Administration icon. The Security Console displays the Administration page.
Click Manage shared credentials for scans.

The Security Console displays a page with a table that lists each set of shared credentials and related configuration information.

Editing shared credentials that were previously created

The ability to edit credentials can be very useful, especially if passwords change frequently.

Click the Administration icon. The Security Console displays the Administration page.
In the Scans > Shared Credentials section, click Manage. The Security Console displays a page with a table that lists each set of shared credentials and related configuration information.
Click the name of the credentials that you want to change, or click Edit for that set of credentials.
Change the configuration as desired. See the following topics for more information:

Verifying scan credential authentication

Upon completion of a scan, on the Scan Overview page, view the Completed Assets table.
Locate the asset you have added credentials to.
Look at the Authentication column for the located asset.
For more information on Understanding Credential Authentication Status, see the next section.
For more details, click on the status.

The Security Console will bring you to the Node Page.

In the asset details, locate Credentials and click on the detail listed.
The Security Console will bring you to the Services table.
Under the Authentication column, the security console will display which credential was a success or failure.

Understanding credential authentication status

In the Authentication column, the security console will display one of the following notes to determine the status of your credential authentication:

Unknown: Credentials that do not return a success status or run a discovery scan.
Partial Credential Success: Many different types of credentials were used, with one or more service being correct and one or more being incorrect.
Credential Success: Correct credentials were provided for range of assets.
Credential Failure: Incorrect credentials were provided for range of assets.
No Credentials Used: No credentials provided for range of assets.