DeepSurface: Scan Groups
DocumentationInstallation Guide
Overview
Let DeepSurface Host For You
Getting Started
System Requirements
Self Hosted Quick Start - Installing to Cloud Platforms
Self Hosted - Installation Using an OVA
Registration, Package Installation, and Initialization
First Steps After Initialization of the Console
Deployment Options
Main and Subordinate Consoles
Agent-Based Deployment
User Managed Scan Deployment
Credentialed Scanning Deployment
Mixed Environment
Deployment Tools
Active Directory Group Policy
Microsoft Endpoint Configuration Manager (part of InTune)
Tanium Deploy
HCL BigFix
Ivanti
Virtual Machines
VMWare
Virtual Box
VirtualBox Guest Additions
AWS EC2 (BYOL)
AWS EC2 (Usage Based)
Azure Cloud
Google Cloud
Additional Items to Consider
Main Console Server Certificates
LDAP
TOFU
Clock Sync
DeepSurface Commands
Multiple Vulnerability Sources
API Documentation
User Guide
Reporting
Dashboards
Exports
Risk Insight
Hosts
Patches
Vulnerabilities
Vulnerability Instances
Users
Remediation Workflow Manager
Plans
Settings
Integrations
Workflow
Exporting
Accepted Risk Plans
Accepted Risk Workflow
Explore
Model
Paths
Activity
Tasks
Configuration Alerts
Scan Logs
Notification Settings
Scanning
Status
Agents
User Managed
Credentialed Scanning Settings
Credentials
Scan Groups
General Settings
Cloud Scanning
Network Connectivity
Subordinates
Vulnerability Sources
Setup
Sensitive Assets: Polices
Sensitive Assets: Manual
Admin Settings
SMTP Settings
Certificates
Outbound Proxy
Authentication Providers
Users
Tags
Integrations Guide
Vulnerability Sources
CrowdStrike Spotlight
SentinelOne
Carbon Black Cloud
Microsoft Defender for Endpoint
Wazuh
Lansweeper Cloud
Nessus API
Tenable.io API
Security Center/Tenable.sc API
Rapid7 InsightVM API
Qualys API
Nozomi Guardian
Eclypsium
AWS Inspector
Remediation
Jira Software
Tanium (BETA)
Authentication Providers
LDAP (Active Directory)
SAML (Azure Active Directory)
SAML (Google)
SAML (Okta)
PAM
CyberArk
Delinea (Thycotic)
Microsoft LAPS
Security Guide
Firewall Configuration
Base Network Requirements
Agent Network Requirements
Credentialed Scanning Network Requirements
API Network Requirements
How DeepSurface Scans Work
Domain (LDAP) Scanning
Host Scanning Routine
Reasons for the Administrative Access Requirement
Endpoint Protection Considerations
Other Items
Scope of Data Storage and Retention
IPS/IDS Considerations
Logging
Resetting the DSADMIN password
Product Information
Changelogs
Open source Licenses
End User License Agreement (EULA)
In order for DeepSurface to be able to do any credentialed scans, you must configure scan groups. A scan group is a subset of your environment that includes a specific IP address range and specific settings and credentials that pertain to the hosts within the specified IP range. To configure a scan group, first make sure you have at least 1 credential configured (for more information on credentials, read the documentation here) and then head to Scanning > Credentialed > Scan Groups and click the "+ Scan Group" button in the top right. You should see something like the following:
There a 2 tabs within the scan group edit/create interface. The first tab contins the name and IP range fields. A name is required, as well as at least 1 included IP address. Clicking on the help icon will give you more information about each field, but simply put, in order for a scan group to know what machines to scan, it needs to know what IP ranges are to be included in this group. IP ranges can be separated by commas or spaces, as well as newlines. You may know that particular ranges within an included range should be ignored for some reason, so you may optionally also enter ranges to exclude from the included ranges. Once you have specified the range of the scan group, the second tab is where you can dial in all of the specific settings, schedule, and credentials for this scan group.
Credentials
By default, a newly created scan group will automatically include all available credentials and prioritize them in the default order that was created by dragging and dropping the credentials in the credential interface. Credentials can be removed, added, or re-ordered in this interface as well, however, as they make sense for this specific scan group. Simply click the remove "-" icon on any included credential to remove it, and grab any included credential to reorder it by dragging and dropping it within the list.
Scan Default Overrides
We will come back to the schedule settings below the credential section, but next we will take a look at the "Scan Default Overrides" section. These settings control different options and parameters for how a scan is conducted for this particular group. Clicking on any of the "?" help icons will give you more information about any of the settings. All of the values for these settings are inherited from the global system-wide defaults set in the Scanning > Credentialed > Settings but each can be overridden within this interface. To override one of the global settings for this particular scan group, click the override toggle and then adjust the value for the setting accordingly. This value will persist, even if the underlying global value that it is inheriting from were to change in the future.
Schedules
While it is possible to manually kick off an credentialed scan at any time from the Activity > Tasks interface, it is highly recommended to configure a schedule for this scan to run on. Scans can be configured to run Daily, Weekly, or Monthly, on a particular day of the week, and even at a particular time of day. As covered in the documentation for the tasks interface here, adding a schedule to a scan group will ensure that different scan groups are scanned at regular intervals. All scheduled scan groups will show up in the Activity > Tasks interface as well. And a scan group can even have more than one schedule. It is also possible to kick off a manual scan at any time by simply clicking the "Scan" button from the scan group item. Doing so will add that job to the queue and run at the next possible availability.