Qualys Network Passive Sensor Getting Started Guide
Qualys Network Passive Sensor Getting Started Guide
Qualys Network Passive Sensor Getting Started Guide
June 6, 2023
Verity Confidential
Copyright 2022-23 by Qualys, Inc. All Rights Reserved.
Qualys and the Qualys logo are registered trademarks of Qualys, Inc. All other trademarks
are the property of their respective owners.
Qualys, Inc.
919 E Hillsdale Blvd
4th Floor
Foster City, CA 94404
1 (650) 801 6100
Table of Contents
About this Guide ...............................................................................................4
About Qualys ........................................................................................................................... 4
Qualys Support ........................................................................................................................ 4
Verity Confidential
About this Guide
About Qualys
About Qualys
Qualys, Inc. (NASDAQ: QLYS) is a pioneer and leading provider of cloud-based security and
compliance solutions. The Qualys Cloud Platform and its integrated apps help businesses
simplify security operations and lower the cost of compliance by delivering critical
security intelligence on demand and automating the full spectrum of auditing,
compliance and protection for IT systems and web applications.
Founded in 1999, Qualys has established strategic partnerships with leading managed
service providers and consulting organizations including Accenture, BT, Cognizant
Technology Solutions, Deutsche Telekom, Fujitsu, HCL, HP Enterprise, IBM, Infosys, NTT,
Optiv, SecureWorks, Tata Communications, Verizon and Wipro. The company is also
founding member of the Cloud Security Alliance (CSA). For more information, please visit
www.qualys.com
Qualys Support
Qualys is committed to providing you with the most thorough support. Through online
documentation, telephone help, and direct email support, Qualys ensures that your
questions will be answered in the fastest time possible. We support you 7 days a week,
24 hours a day. Access online support information at www.qualys.com/support/.
4
Welcome to Qualys Network Passive Sensor
5
Welcome to Qualys Network Passive Sensor
What are the Benefits?
Passive Sensor analyzes existing network traffic without sending a single packet to the
devices being discovered.
Get insights to the asset’s network activity, with traffic summary categorized by
ingress/egress, service type, and port/protocol.
Drill down to traffic between a source and destination. You’ll get enterprise application
identification (e.g. database) based on traffic pattern.
6
Welcome to Qualys Network Passive Sensor
How it Works
How it Works
The Network Passive Sensor (PS) is placed inside your network and takes snapshots of the
data flowing over the network. It extracts metadata from these snapshots and sends them
to the Qualys Cloud Platform for analysis. This allows us to catalog the assets by operating
system and hardware.
• Asset De-duplication With Managed Assets:
If an asset discovered by the sensor is already known by active scanning or is reported by a
cloud agent, then it is considered a managed asset and NPS de-duplicates the passively
sensed asset with the managed asset using the Cloud Agent correlation ID, MAC address,
hostname, or IP as a criteria (please refer to the below section for IP-based de-duplication
criteria). A de-duplicated asset is listed in the managed inventory.
De-duplication uses the following criteria in the order of descending priority:
• De-duplication based on correlation ID works if passive sensor discovers correlation ID
and the same is available for a managed asset. The way NPS learns the correlation ID is if
gets a copy of the scan traffic when the Qualys scanner runs a VM scan of the asset
containing a cloud agent and the scan profile has the QID that queries the asset for it’s
correlation ID.
Note: The agent correlation ID is generated by agents installed on Windows and Linux
hosts. VM scan also has an option to use the agent correlation ID to de-duplicate agent-
collected data with the results of authenticated or unauthenticated scans.
• De-duplication uses MAC if asset is not de-duplicated using correlation ID.
• If MAC is also not known, then an exact match is necessary for hostname-based de-
duplication. If the passive sensor senses "johndoe" as the hostname and the managed
asset’s hostname is reported with a domain name such as "johndoe.somedomain.org" or
vice versa, the assets will not duplicate. In such cases, user can add domain names such
as “somedomain.org” as input to NPS, for it to de-duplicate it with the managed asset. To
add a domain, go to the Sensors tab and click View Details from the Quick Action menu
of a sensor. Alternatively, you can click the sensor and go to the sensor details page >
General Settings > Add domain. To learn more about configuring the domains, refer to
the Online Help.
• Finally, if neither of the above conditions are met, then NPS uses only the IP address to
de-duplicate provided both managed and un-managed IPs are in the same network. For
details on the need of the Network feature, refer to Appendix D, "Extending the Network
Feature Section," of the Qualys Network Passive Sensor Appliance User Guide. If user does
not have “Network” in the subscription, NPS defaults to treating all IPs as a part of one
global default network.
IP-only de-duplication uses additional IP configuration: dynamic (DHCP) and static IPs. An
unmanaged asset with a static IP is immediately de-duplicated with the managed asset of
the same IP. If the unmanaged asset has a dynamic IP assigned from the DHCP pool, the
de-duplication with the managed asset of the same IP happens provided the timestamp of
the managed scan and the timestamp of the asset seen by passive sensor are close to each
other i.e. within a stipulated time period. This time period is the asset's DHCP lease period
identified by PS or the IP inactivity time period if PS is unable to discover the DHCP lease
7
Welcome to Qualys Network Passive Sensor
How it Works
period in cases where DHCP flow is not seen on sniffing interface or the appliance is
overloaded and drop the DHCP packet. The user can configure an IP subnet/range as static
or dynamic at the time of configuring the internal asset configuration for the appliance.
The asset reported by passive sensor is listed in the unmanaged inventory provided:
1. Asset is not detected by an active scan
2. Asset is detected by active scan but not yet de-duplicated
• De-duplication Within Unmanaged Assets:
NPS de-duplicates assets within the unmanaged inventory based on MAC address,
hostname or IP.
De-duplication uses the following criteria:
• Hostname-based de-duplication happens only for non-mobile devices or for hostnames
not added to the exclusion list. Refer to the General Settings section of the Network
Passive Sensor (NPS) Online Help for more details on adding hostnames to the exclusion
list and why it is needed.
• NPS de-duplicates assets within the unmanaged inventory based on IP, when same IP is
reported by multiple passive sensors, provided all sensors are part of the same network
(Network subscription and configuration is needed only when the enterprise network has
overlapping/same IP addresses). As a result, if more than one passive sensors are deployed
in a network and are configured with the same IP addresses in the internal asset
group,then NPS de-duplicates assets reported by different passive sensors if the IP address
is the same and provided that MAC address is not learnt. IPs configured as static qualify
for immediate de-duplication, whereas for IPs configured as DHCP, assets will be de-
duplicated only if their timestamps are close enough – i.e. within IP inactivity time.
Note: If the user configure Network Passive Sensor (NPS) with an IP as static in one
internal asset group and the same IP as DCHP in a different internal asset group, then NPS
treats the IP as static.
In an enterprise having 2 subnets that have the same/overlapping IP addresses would
need,
a) to deploy 2 passive sensors, one for each network.
b) would want to inventory assets uniquely within each subnet and not have the same IP
(seen without MAC or hostname) reported by the 2 passive sensors, de-duplicate into one
asset.
To do this, user must associate each sensor to its own network and also create network
range tags that are a combination of network and IP ranges. A tag can be created in VMDR
> Assets > Asset Groups > New Asset Group OR CSAM > Tags > New Tag > Create tag.
Create a dynamic tag with the rule "IP Address in Range(s) + Network(s)".
To elaborate the above with an example, take the case of an enterprise has 2 branch
offices in locations L1 and L2. Both locations have the same subnet allocated to Wifi
network- say IP range IPn. Passive sensor NPS1 and NPS2 are 2 sensors deployed to sense
subnet IPn in locations L1 and L2 respectively.
8
Welcome to Qualys Network Passive Sensor
Exclude Hostname from asset de-duplication
User must,
a) Create 2 networks N1 and N2 for locations L1 and L2
b) Configure NPS1 with network N1 and NPS2 with network N2
c) Create tags T1 and T1 of type IP2+Network such that T1 = N1, IPn and T2= N2, IPn
The above configuration ensures that when same IP is reported by NPS1 and NPS2, 2
separate assets one in each network is created.
The following table summarizes the asset de-duplication criteria used in NPS:
Qualys Cloud Macs IPs Hostnames Network De-dupli-
Agent Cor- cate?
relationID
Same Doesn’t Doesn’t Matter Doesn’t Matter Doesn’t Matter Yes
Matter
Not Available Same Doesn’t Matter Doesn’t Matter Doesn’t Matter Yes
9
Welcome to Qualys Network Passive Sensor
Sensor Deployment Options
another common one used by all HMI devices. To track each such device as an
independent asset in the inventory, the user can add the common switch hostname and
the common HMI hostname in the exclusion list provided by this feature.
Management Interface
The management interface is used for connecting to the Qualys Cloud Platform and for
streaming asset metadata to the Qualys Cloud Platform, as well as performing
management and maintenance activities remotely from the Qualys UI.
You’ll assign an IP address to the management interface either statically or using DHCP.
DHCP is enabled by default. Configuring the management interface is required for the
Passive Sensor to have Internet connectivity and to connect to the Qualys Cloud Platform.
10
Welcome to Qualys Network Passive Sensor
Appliance Connectivity and Interfaces
Sniffing Interface
One or more traffic sniffing interfaces are used to receive mirrored traffic to the Network
Passive Sensor. Once the traffic that needs to be monitored is identified: 1) Configure the
switch that sees the traffic in question by mirroring the traffic to a port, 2) Connect that
mirrored port to the passive sensor sniffing interface of the sensor, and 3) Enable
“Promiscuous Mode” on respective vSwitch and port group.
You will not assign an IP address to the sniffing interface.
The following picture shows connectivity for a physical appliance. You’ll see that the
sniffing interface of the appliance is connected to the network switch and mirrored traffic
is fed from the switch to the appliance. The management interface connects to the cloud.
The following picture shows connectivity for a virtual appliance. The virtual appliance is
supported on the VMware ESXi Server virtualization platform and Microsoft Hyper-V.
Again the sniffing interface is fed mirrored traffic from the network switch. The
management interface is configured to connect to the cloud.
11
Welcome to Qualys Network Passive Sensor
Network Placement and Sensor Sizing
12
Quick Steps
Before you Begin - Mirror the Traffic
Quick Steps
You’ll deploy the appliance on your network, generate a personalization code, and use the
code to register the appliance with the Qualys Cloud Platform.
13
Quick Steps
Step 2 - Deploy and Register the Appliance
Physical Appliance
Depending on your appliance variant (with LCD or without LCD), you can do your
configurations using LCD interface for using remote console connected using serial port.
Configurations using LCD interface - Plug-in the physical appliance on your network. Then
use the LCD display on the appliance to make network configuration settings (static IP,
proxy). You’ll also register the appliance using the personalization code copied from Step 1
by entering it using the LCD display on the appliance. Refer to the Physical Appliance User
Guide for the detailed steps.
Configurations using serial port- Plug-in the physical appliance on your network. Then use
PuTTY to connect using serial port and to display remote console for network
configuration settings (static IP, proxy). You’ll also register the appliance using the
personalization code copied from Step 1 by entering it using the option in the remote
console. Refer to the Physical Appliance User Guide for the detailed steps.
Virtual Appliance
Download the virtual appliance image from the New Sensor wizard or from Home >
Deploy Network Sensor > Virtual Sensor in the Network Passive Sensor UI and deploy it in
VMware ESXi or Microsoft Hyper-V. When you start up the new virtual machine a virtual
console window appears where you’ll make network configuration settings (static IP,
proxy). You’ll also register the appliance using the “Personalize this scanner” option in the
console window. Refer to the Virtual Appliance User Guide for the detailed steps.
Internal Assets
To add internal assets, simply go to Configuration > Internal Assets > Add.
14
Quick Steps
Step 3 - Configure Assets
Here, you’ll define the IP ranges within your network you want to monitor. The assets
discovered for these IP addresses will be individually inventoried and tracked for traffic
analysis. You can use default IP ranges, IP range tags, or customized IP ranges options to
define range of internal assets. Select Do you want to inventory the assets check box for
marking inventoried assets.
To complete the sensor setup and to start sensing assets you must define Internal Asset
ranges. The passive sensor senses all the traffic that you have mirrored. However, by
defining internal asset ranges, you choose the assets you want to monitor and report on.
15
Quick Steps
Step 3 - Configure Assets
1 - Default IP Ranges
This option defines internal assets discovered within default internal ranges for your
network. Click Select Sensors to select sensor from the list of sensors for which you want
to define internal asset.
2 - IP Range Tags
This option defines internal assets discovered with IP range tags. These are the dynamic
tags created with ‘IP Address In Range(s)’ rule engine. Click Select Sensors to select sensor
from the list of sensors for which you want to define internal asset. Click Select IP Ranges
to select IP tags from the list of tags for which you want to define internal asset.
16
Quick Steps
Step 3 - Configure Assets
3- Custom IP Ranges
This option defines internal assets discovered with custom IP ranges. You can provide IP
ranges for monitoring. Click Select Sensors to select sensor from the list of sensors for
which you want to define internal asset.
Excluded Assets
Here, you’ll define the IP ranges or MAC addresses to be excluded from the inventory. The
assets discovered for these addresses will be masked as Excluded in the traffic summary.
To add excluded assets, simply go to Configuration > Excluded Assets > Add.
17
Quick Steps
Step 3 - Configure Assets
To add external assets, simply go to Configuration > Monitor External Assets > Add.
General Settings
Navigate to Configuration > General Settings and go to the recipient’s text box and add
the e-mail or you can add multiple e-mails using comma separated. Click Save.
Here, you can configure your mail address/addresses to receive the alert notification for
events like Driver Change Required, Reboot Required, and Asset Reporting Stopped.
After you've added the recipients, you'll receive the events in your e-mail inbox.
Also, you can configure hostnames that need to be excluded while de-duplicating
unmanaged assets or de-duplicating unmanaged assets into managed assets. The
hostnames provided here are case-insensitive. When a new hostname is added to the
exclusion list, make sure first to purge the asset created for that hostname. Refer above
screenshot for configuring excluded hostnames.
Note: Please contact Qualys Customer Support to get them deleted to avoid deduplication
in the future.
18
Quick Steps
Step 4- Check the status
Also, you can see the latest events generated in the events section of the sensor details
page.
19
Quick Steps
Classification of Assets in Passive Sensor
You can toggle your view between All, managed and unmanaged assets at any time.
20
Quick Steps
Classification of Assets in Passive Sensor
What is Inventory
PS uses IP addresses in this range to
a) Create assets and inventory various asset attributes such as hostname, MAC address,
protocol specific attributes, etc.
b) Track traffic flows to/from these IPs to other all other IPs outside this range.
Assets with IPs in this range are listed under the CSAM inventory.
PS aggregates the traffic flows from an IP in the internal range to another IP in the internal
range by 4-tuple of Source IP, Destination IP, Destination port, and TCP or UCP protocol.
Appliance reports traffic flows at an interval of 5 minutes for new assets and at 30
minutes for asset updates.
The appliance aggregates multiple flows of the same tuple into one flow when reporting it
in the 5- or 20-minutes reporting interval.
For example, if Asset A1 initiated HTTP flow to a webserver A2 multiple times within the
30 minutes interval, PS aggregates these flows and reports a single HTTP flow from A1 to
A2 at reporting time.
21
Quick Steps
Classification of Assets in Passive Sensor
What is Non-inventory
PS uses IP addresses in this range only for tracking traffic flows to other IPs in the
inventory range and NOT for inventory purpose. Assets in this IP range do not show in the
CSAM inventory. However, traffic flows to/from these assets are listed in the Network tab
of CSAM and under the inventoried asset-centric traffic tab of CSAM.
22
Quick Steps
Classification of Assets in Passive Sensor
What is Excluded
If there is a need to not see some sensitive or confidential assets listed in the inventory,
then the passive sensor allows the user to specify configuring IPs and/or MACs in the
Excluded range.
23
Quick Steps
Classification of Assets in Passive Sensor
24
Quick Steps
Classification of Assets in Passive Sensor
25
Best Practices
Best Practices
This section contains certain best practices to follow when configuring the internal assets
in PS appliances.
The enterprise network in the above scenario has 2 branches A and B. There are 2 sensors
deployed one each in branch A and B. For the enterprise network subnets A and B together
make up the range on IPs for internal assets that have to be inventoried. Assets A.1, A.2,
and A.3 belong to subnet A and B.1, B.2, and B.3 belong to subnet B.
Now consider a case where there is intra branch traffic. Each of the sensors in branch A
and B will "see" traffic flows from/to assets in subnets A to B.
For example, if A.1 were to initiate a flow to B.1, both sensors would sense this flow. If both
sensors are configured with subnet A and B as the internal (inventoried) range, then both
sensors will report assets A.1 and B.1 causing the same assets to be reported twice to
Qualys cloud. This causes additional workload on the cloud services and this may result in
delayed or missed updates of the assets or traffic flows as seen in the asset or traffic
listing.
This workload multiplies if there are flows from each one of the assets in subnet A to B.1,
such as A.1 to B.1, A.2 to B.1, and A.3 to B.1.
So, adding the same subnet into multiple sensors is inefficient and not a recommended
configuration.
26
Best Practices
27
Best Practices
So here is what the configuration of PS appliance in each crane would look like
Crane #1
- Add Crane#1 IP range R1 in Asset Group AG1 in Network N1 in VM module
- Run policy compliance scan for the asset group AG1 in N1 in VM module
- Add NPS1 to Network N1 and configure NPS 1 to sense IP range R1 in N1
Crane #2
- Add Crane#2 IP range R2 in Asset Group AG2 in Network N2 in VM modules
- Run policy compliance scan for the asset group AG2 in N2 in the VM module
- Add NPS2 to Network N2 and configure NPS 2 to sense IP range R2 in N2
28