SSH Key Discovery job workflow
The SSH Key Discovery jobs discover SSH keys of the accounts that are in the scope of the profile. You can configure, schedule, and run SSH Key Discovery jobs. After a job has run, you can view the Discovered SSH Keys under the tab of that name. You will see the following: Key Fingerprint, Comment (that is in the key), Key Type, Key Length, Asset Name, Account Name, and Account Status ("managed" means Safeguard for Privileged Passwords manages the account, and "disabled" means Safeguard for Privileged Passwords does not manage the account).
- Set up the partition with the SSH key profile. For more information, see SSH Key Profiles tab (partitions)..
- Create an SSH Key Discovery job. For more information, see Adding an SSH Key Discovery job..
-
SSH Key Discovery jobs can be scheduled to run automatically. In addition you can manually launch a job on a single account:
- From Asset Management > Discovery > SSH Keys select the SSH Key Discovery job to run, then click Discover SSH Keys.
-
After the SSH Key Discovery job runs, click SSH Key Discovery Results tile to view the SSH Keys found. For more information, see SSH Key Discovery Results..
NOTE: The discovery job finds all current SSH keys that match the discovery rule's criteria. SSH Key Discovery does not update existing accounts.
Search the Activity Center for information about discovery jobs that have run. Safeguard for Privileged Passwords lists the SSH Key Discovery events in the SSH Key Discovery Activity category. For more information, see Activity Center..
Adding an SSH Key Discovery job
It is the responsibility of the Asset Administrator or the partition's delegated administrator to configure the rules that govern how Safeguard for Privileged Passwords performs SSH key discovery. For more information, see SSH Key Discovery job workflow..
To add an SSH Key Discovery job
- Navigate to Asset Management > Discovery > SSH Keys.
- Click New SSH Key Discovery Job to open the New SSH Key Discovery Job dialog.
- Provide the following:
-
Name: Enter a name for the account discovery job. Limit: 50 characters.
-
Description: Enter descriptive text about the SSH Key Discovery job. Limit: 255 characters
-
Partition: Browse to select a partition.
-
To identify when to Discover SSH Key, on the Schedule tab:
-
Select a time frame:
- Never: The job will not run according to a set schedule. You can still manually run the job.
- Minutes: The job runs per the frequency of minutes you specify. For example, Run 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 Run Every 2/Hours/@ minutes after the hour 15.
-
Days: The job runs on the frequency of days and the time you enter.
For example, Run 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, Run 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 Run Every 2/Months/Starting @ 1:00:00 AM along with Day of Week of Month/First/Saturday, 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 Run Every 10/Minutes and set Use Time Windows:
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 Run Every 2/Days and set Use Time Windows as Start 4:00:00 AM and End 8:00:00 PM and Repeat 2.
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.
- To save and close , click OK.
SSH Key Discovery Results
You can view the results of running one or more SSH Key Discovery jobs. To see the results of discoveries, see Discovered SSH Keys.
To view SSH Key Discovery Results
- Navigate to Asset Management > Discovery > SSH Keys > (add or edit an SSH Key Discovery job).
- On the SSH Key Discovery Results tab:
- Select the time frame of the completed jobs you want to display which ranges from the last 24 hours to the last 7, 30, 60, or 90 days. Or, click Custom to create a custom time frame.
- Click Refresh to refresh the results.
- To display what you want in the grid, click Search and enter the character string to be used to search for a match. For more information, see Search box..
- View the following information displays for each job:
-
Date/Time: The most recent date the SSH Key Discovery job successfully ran.
-
User: The user who ran the job or Automated System, if the job is run on an automated schedule.
-
Event: The outcome of running the SSH Key Discovery job event, which may be SSH Key Discovery Succeeded, SSH Key Discovery Failed, or SSH Key Discovery Started.
- Account: The account which is associated with the SSH Key Discovery job .
- Asset: The asset which is associated with the SSH Key Discovery job.
- Partition: The partition in which the discovered SSH keys will be managed.
- SSH Key Profile: The profile which will govern the discovered SSH keys.
- Appliance: The name of the Safeguard for Privileged Passwords Appliance.
- # SSH Keys: The number of SSH Keys found during the discovery job; click the displayed number to view the list of SSH Keys found on the account.
Discovered SSH Keys
You can view the current SSH Key Discovery results for a selected partition. The number of discovered keys for an account will reflect the number of SSH keys discovered in the account's authorized keys file.
SSH keys currently in use by an account will have a check mark in the SSH Key Managed column in the Discovered SSH Keys properties grid (see below).
Go to Discovered SSH Keys:
- web client: Navigate to Asset Management > Discovery > Discovered Items > SSH Keys tile.
Select the partition for which you want to see the SSH Key results.
Use these toolbar buttons to manage the discovered accounts.
Table 143: Discovery: Discovered SSH Keys toolbar
Revoke |
Use this button to revoke access for unmanaged SSH keys. |
Export |
Use this button to export the listed data as either a JSON or CSV file. For more information, see Exporting data. |
Refresh |
Retrieve and display an updated list of discovered SSH keys. If SSH Keys are deleted from the account's authorized keys file, they will be removed from the discovered list when the discovery job runs. |
Search |
Enter the character string to be used to search for a match. For more information, see Search box.. |
The following information displays.
Table 144: Discovery: Discovered SSH Keys properties grid
Fingerprint |
The fingerprint of the SSH key used for authentication. |
Account Status |
The status of the account where the SSH key was discovered. |
SSH Key Managed |
This column will have a check mark indicating the SSH key currently in use on the account. |
Comment |
Free form comment included in the SSH key. |
Key Type |
The SSH authentication key type, such as RSA and DSA. For more information, see SSH Key Profiles.. |
Key Length |
The supported RSA or DSA key length displays. For more information, see SSH Key Profiles.. |
Asset Name |
The name of the asset where the SSH key was discovered. |
Account |
The name of the account where the SSH key was discovered. |
Date/Time Discovered |
The date and time when the SSH key was discovered. |