DeepSurface

Documentation
Installation 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)

Users on the DeepSurface console can be auto-provisioned using Microsoft Entra ID, leveraging the single sign on configuration that should be set up as documented here.

After you have set up the Microsoft Entra ID SAML application and your existing users can log in with their accounts, do the following:

  1. Enable your Microsoft Entra ID authentication provider to be the assigned auto-provisioning candidate.

Entra ID Auto Provision

  1. At this point, DeepSurface will allow users to automatically provision into the console, however the users you have assigned to your SAML app in Microsoft Entra ID will only pass their email address as a user name to the console. You will need to add claims to your Entra ID SAML app.

  2. Navigate back to the Azure Portal, and select _Microsoft Entra ID -> Enterprise Applications, click on the SAML application you configured; select Single sign-on and click on the Edit link in the Attributes and Claims section.

    AZURE AD

  3. The required attributes (claims) are created correctly out of the box, with the small exception that they need to have their 'Name Format' edited to be 'Basic'. Click into each claim and modify the Name Format drop down to be 'Basic'.

    AZURE AD

  4. Role based access control in DeepSurface requires passing a custom attribute from the Enterprise Application you created in the Azure Portal. To create a custom attribute, refer to the documentation provided by Microsoft. The attribute value must be one of the following: 'admin', 'report_manager', 'report_consumer'. It must map to the 'role' DeepSurface Console application attribute.

  5. Email Address, Given Name, and Family Name will all be appropriately populated in the DeepSurface console when users log in using their 'Entra ID' username and are granted permissions to the SAML application you created in Azure.