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 Google, leveraging the single sign on configuration that should be set up as documented here.

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

  1. Create a custom attribute to contain the RBAC role that a DeepSurface user can be assigned through SAML auto-provisioning. Go to your Google Workspace administrative interface and access Directory -> Users -> More Options -> Manage custom attributes

Google App Editor

  1. Click 'Add Custom Attributes' in the top right hand side of the page.

Google App Editor

  1. Category and Description can be whatever suits your environment. Under 'Custom Fields', add the values as identified below:

    • name: 'role'
    • Info type: 'Text'
    • Visibility: 'Visible to Organization'
    • No. of values: 'Single Value'
  2. Go to Directory -> Users and select a user that you would like to assign a specific role to in the DeepSurface console. Acceptable values for the 'role' custom attribute are 'admin', 'report_manager', 'report_consumer'.

  3. Under the user you have selected, click into the 'User Information' panel, and scroll to the category you designated for the custom attribute you created. Click the attribute to edit it, and enter one of the three values designated above. If you designate no value, the user will a 'report_consumer' in the DeepSurface console, if they have been given permission to use the SAML app you have created.

  4. Log into the Google Admin interface and access Apps - > Web and mobile apps and select the SAML app that you created to use SSO authentication with DeepSurface.

Google App Editor

  1. Click on Configure SAML atttribute mapping, and add the attributes as shown below. The 'role' attribute is your custom attribute, the 'App attributes' MUST be 'role'.

Google Attribute Mapping

  1. Log into your DeepSurface console and assign your Google SAML provider to perform auto provisioning.

Google Auto Provisioning

  1. Be sure your Google SAML app is enabled for everyone, or assigned to groups or organizational units in your Google Workspace that contain users you would like to be able to log in to the DeepSurface console.

Google Auto Provisioning

  1. Navigate to your DeepSurface console and log in with a Google Workspace user that has the SAML app enabled for them. Their email, first name and last name will auto provision to the DeepSurface console when they complete the Google Authentication process.