Eclypsium Network Devices Solution Guide 2.9.0
Eclypsium Network Devices Solution Guide 2.9.0
Eclypsium Network Devices Solution Guide 2.9.0
OF THE ENTERPRISE
Version 2.9.0
Dec 2021
Eclypsium Proprietary
1
Solution Overview 5
System Requirements 5
Prerequisites 5
Supported Operating Systems 6
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
2
Known Limitations 18
Configuring SCP for Cisco IOS devices 19
Deep coverage for Cisco Nexus (NX-OS) 20
Enabling REST API 20
HTTPS API - Configuration example 20
SSH - Configuration example 21
Configuring SCP 21
Deep coverage for Aruba devices 22
ArubaOS-CX 22
Enabling REST API 22
HTTPS API - Configuration example 22
SSH - Configuration example 23
Limitations 23
ArubaOS-Switch 23
Configuration example 23
Extending Deep coverage using templates 24
Download device's binary for Cisco 24
Deep Coverage Visualization 25
Authenticated Scans filters 25
Device Summary 26
Device Details 26
Protocol Info 27
Device examples 28
Cisco IOS 28
Cisco Nexus (NX-OS) 30
Arista 31
Juniper 32
Pulse Secure 34
Citrix 35
ArubaOS-CX (Aruba) 36
ArubaOS-Switch (Aruba) 37
Palo Alto Networks 38
Fortinet Fortigate 39
OS Specific configuration 39
CentOS 7 40
Firewall configuration 40
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
3
Credential Manager 41
Registering a credential manager 41
Other options to register a Credential Manager 42
Format of credentials 43
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
4
Solution Overview
The Eclypsium Network Devices Scanner is a tool that was added to the Eclypsium product,
allowing the customer to discover and monitor devices in the corporate network.
The system uses multiple network scanning techniques to identify devices and then sends the
returned information to the Eclypsium Platform for analysis and presentation.
Once the Scanner is fully operational, the network administrator will be able to generate scans
on demand.
System Requirements
Prerequisites
The Network Scanner is an application installed on a host connected to an active Eclypsium
Platform. The prerequisites are:
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
6
Quick Start Guide
Installation
The Eclypsium Network Device Scanner does not require any installation. Copy the executable
provided by the Solutions Team to the folder created by the Eclypsium scanner during its
deployment.
NOTE 1: The Network Device Scanner is not downloadable from the web console and will be
provided by the Solutions Team.
Registration
The Eclypsium Network Devices Scanner requires registration with the Platform. Upon
registration, the Scanner will do two things: First, it will update the
Eclypsium Platform that a Network Devices Scanner is available on this host. Then, it will
execute a scan based on the Platform configurations.
To execute registration run:
● On Windows (as Administrator):
cd \"Program Files\Eclypsium"
EclypsiumNetworkApp.exe --register
● On Linux:
sudo EclypsiumNetworkApp --register
Common errors
● Errno 13 - will appear if the registration process is not run as an administrator or with
root privileges
● "No pending host tasks found. Exiting..." - This message will appear if the --register
flag is missing.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
7
Activate Scanner's listener
To activate the listener, follow the instructions below. We recommend configuring a recurring
task every 2 hours.
Windows
schtasks.exe /create /tn EclypsiumNetworkApp /tr "'C:\Program
Files\Eclypsium\EclypsiumNetworkApp.exe'" /sc HOURLY /mo 2
After creating the scheduled task, you will need to make the following changes:
1. Open the Task Scheduler as Administrator
2. Edit the active task for EclypsiumNetworkApp
3. Navigate to the Actions tab
4. Edit the scheduled task
5. Set the Start in (optional) field to C:\Windows\Temp
Note: If, during installation, you chose a folder other than "\Program Files\Eclypsium," you
should use the appropriate folder where you installed the agent.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
8
Linux
(sudo crontab -l ; echo "0 */2 * * * cd /tmp && EclypsiumNetworkApp")
| sudo crontab -
NOTE 1: Crontab user is required to be root
NOTE 2: If in the first step, you chose a folder other than /usr/bin, you should use that folder
instead
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
9
Validate the task configuration by running sudo crontab -u root -l
Initiating a scan
You can now initiate a scan either from the Eclypsium Web Console or from the CLI on the host.
When the scan starts, you will be able to see in the console the logs of the scanning:
$ sudo EclypsiumNetworkApp
2021-10-13 16:27:42,572 - scanner - [+] Scanner version: 0.0.0
2021-10-13 16:27:43,232 - scanner - [+] Scanning started
2021-10-13 16:27:43,264 - device.protocol_pipeline - [+] Running pre-scan actions
2021-10-13 16:27:53,450 - device.protocol_pipeline - [+] Scanning device 172.16.10.1
2021-10-13 16:27:53,451 - device.protocol_pipeline - [+] Scanning device 172.16.10.2
...
...
Parameters
-h / --help: Displays help message
-v / --version: Displays scanner version
--ip: Define specific IP addresses to scan. It can be one IP address, several IPs, or subnets
Examples:
--ip 192.168.100.1
--ip 192.168.100.4 192.168.100.1
--ip 192.168.100.0/26
When the value is empty or unprovided, the Scanner will auto-discover the default
network interface and run a scan in the subnet /24 of that IP
--port: Define specific ports to scan. It can be one value or a space-separated list. Default
values to scan are 80, 443, 8080, 8443, 22, 139, 445 and 5060.
--log-level: Set the verbosity level for the Scanner logs. It can be one of the following values:
● SILENT
● CRITICAL
● ERROR
● WARNING
● INFO
● DEBUG
By default is INFO.
--threads: Number of threads to use during the scan. The default value is 16
--no-upload: Disables uploading of scan results to the Platform. Disabled by default
--out-folder: Set the output folder for the scan data. By default uses installation folder
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
11
-- proxy: When deployment requires a proxy to connect to the platform, this parameter can be
added to the command line. Value for the parameter is a JSON like string containing the
protocol and URL of the proxy
On Linux:
--proxy ‘{ “http” : “http://your_proxy_server:3128” }’
On Windows:
--proxy “{\ “http\” : \“http://your_proxy_server:3128\” }”
Note: When using Scheduled tasks, you need to add the parameter proxy to the optional
arguments. Check this section following same steps than for configuration file
Linux
1. sudo crontab -e
2. Open the desired text editor when asked
3. Replace
* */2 * * * cd /tmp && EclypsiumNetworkApp
With
* */2 * * * cd /tmp && EclypsiumNetworkApp --proxy ‘{ “http” :
“http://your_proxy_server:3128” }’
Windows
1. Edit the scheduled task
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
12
2.
Uninstall
In order to uninstall the Network scanner:
1. Unregister it from Platform
2. Remove the recurring task on the host
3. Remove the executable file from the host
Windows
\"Program Files\Eclypsium\EclypsiumNetworkApp" --unregister
schtasks.exe /delete /tn EclypsiumNetworkApp /F
del "\Program Files\Eclypsium\EclypsiumNetworkApp.exe"
Linux
EclypsiumNetworkApp --unregister
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
13
sudo crontab -l | grep -v EclypsiumNetworkApp | sudo crontab -
sudo rm /usr/bin/EclypsiumNetworkApp
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
14
Enable/Disable Network Scan
A Network scanner can be enabled or disabled for a single host on the Device Page of said
host. Use the Scan Network toggle to control the service.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
15
Network Scan Settings
Configuration for scanners is managed remotely by the Platform. Eclypsium's representatives
will configure it for you. You can override the global configuration at the device level at any time.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
16
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
17
Enable Logging of Unauthenticated Requests
1. Go to System -> Log/Monitoring -> User Access -> Settings
2. Click on the Unauthenticated Requests checkbox
3. Click on Save Changes
Known Limitations
● Connections to Pulse Secure devices have limitations due to the way the API works.
While collecting logs from the device, you need to ensure that you have logged out of
the Administration console with the user you configure for Deep coverage scanning
because the attempt to connect to the device will fail if you have a session active.
● There is a limit to the number of connections you can establish over specific periods.
Depending on the device's configuration, the session used to scan the device will remain
active for about 5 minutes. If you run another scan in that same window, the deep
coverage scan will fail because since it won’t be able to connect
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
18
Configuring SCP for Cisco IOS devices
If you want to download binary files from Cisco devices, you must enable the SCP protocol on
the target hosts.
b. Activate AAA with auth login & exec default to local credentials:
Note: The commands may vary depending on the desired order for
authenticating in the device.
aaa new-model
aaa authentication login default local
aaa authorization exec default local
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
19
Deep coverage for Cisco Nexus (NX-OS)
Post-authentication is supported on both HTTPS API and SSH protocols in Cisco Nexus
devices. The protocol will be chosen depending on the device configuration.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
20
SSH - Configuration example
{
"targets": {
"192.168.0.62": {
"username": "admin",
"password": "admin",
"optional_args": {
"port": 22
}
}
}
In case we want Deep Coverage to access via SSH, we have to indicate port = 22 in the
configuration file. The driver field is optional here.
Configuring SCP
To be able to download binaries from the Nexus devices, it is required to enable the SCP server
on the targets.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
21
Deep coverage for Aruba devices
ArubaOS-CX
For Aruba switches running ArubaOS-CX, Deep Coverage supports both HTTPS API and SSH
protocols. The protocol will be chosen based on the device configuration.
5. There must be a user on the switch who belongs to the "administrators group" and has a
password set. This user would then be allowed to access the REST API.
Switch(config)# user admin group administrators password plaintext mypassword
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
22
We must pay special attention to some parameters:
● port = 443 → This is the indication for Deep coverage to use HTTPS API protocol.
● driver = “aoscx” → mandatory parameter indicating the driver.
In case we want Deep Coverage to access via SSH, we have to indicate port = 22 in the
configuration file. The driver field is optional here.
Limitations
● REST API supported version is 10.04 - Devices running earlier versions may have
limited support and functionality. For these cases, we recommend configuring with SSH
protocol.
ArubaOS-Switch
The only supported protocol is SSH for the devices running ArubaOS-Switch.
Configuration example
{
"targets": {
"192.168.0.60": {
"username": "admin",
"password": "admin",
"optional_args": {
"port": 22
}
}
}
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
23
Extending Deep coverage using templates
You can extend deep coverage by leveraging templates.
First, you will need to set up specific files that run commands on the device to collect extra data.
Note: The Solution's team will provide the template files and configure them.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
24
Deep Coverage Visualization
Information collected with deep coverage has specific visualizations in the Platform
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
25
Device Summary
You can see in the summary the Firmware Version of the device.
Device Details
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
26
In the Device Details section, you will see detailed information and the Network Interfaces
available on the device.
Protocol Info
In Protocol Information, you will have a specific row detailing the protocol that collected the
Deep Coverage information.
Note: The protocol depends on the device. You can see "Authenticated" next to the protocol
name or something like "PULSE COMMAND API" in the case of Pulse Secure devices
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
27
Device examples
Cisco IOS
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
28
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
29
Cisco Nexus (NX-OS)
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
30
Arista
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
31
Juniper
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
32
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
33
Pulse Secure
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
34
Citrix
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
35
ArubaOS-CX (Aruba)
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
36
ArubaOS-Switch (Aruba)
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
37
Palo Alto Networks
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
38
Fortinet Fortigate
OS Specific configuration
In order for some features to work, changes to the environment are required.
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
39
CentOS 7
Firewall configuration
By default, CentOS has a firewall that blocks incoming packets, this affects protocols like uPnP
and prevents the collection of data. In order to enable collection overuPnP protocol:
Or
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
40
Credential Manager
Integration with Credential Manager is used to obtain a device’s credentials when scanning
with post-authentication/deep coverage.
Integration with Credential Manager and TACACS server looks like this:
Linux
Sudo EclypsiumNetworkApp --register-cred-manager
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
41
2. The scanner will run and ask for credentials
2021-12-30 13:56:46,636 - 140473857625088 - scanner - [+] Scanner version: 2.9.0
Credential manager data:
4. Scanner will display the result of the registration in the command line
Linux
sudo EclypsiumNetworkApp –register-cred-manager ‘{"url":
"https://cred_manager_url", "token": "access_token", "driver":
"vault"}’
2. Using a file
You can use the same JSON content explained in previous section inside a file and run:
Windows (As Administrator)
\"Program Files\Eclypsium\EclypsiumNetworkApp"
–register-cred-manager PATH-TO-FILE
Linux
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
42
sudo EclypsiumNetworkApp –register-cred-manager PATH-TO-FILE
Format of credentials
The scanner expects a predefined format of the credentials and identifier in the vault.
The information used to identify the device is the IP, then the identifier of a device in the vault
must be the IP of the device.
Each secret inside the vault also have a predefined format that should contain:
● username
● password
● Optional: if you are storing community for SNMP, it requires a key snmp and inside the
key community
{
"password": "device_password",
"snmp": {
"community": "public"
},
"username": "device_username"
}
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
43
Revoking credentials
Credentials for Credential Manager registered with a scanner in the Platform, can be revoked at
any time from the scanner’s device page. Once removed, the post-authentication scanning will
fail until new credentials are registered. First time the scanner runs a scan
Scanner
Version Platform Endpoint Scanner
Supported OS
Version Version
2.9.0
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
44
CentOS7 ✅
Windows 10 ✅
Ubuntu
16.04 - 20.04
✅ 2.9.0 and above 2.9.0 and above
Debian 11.x ✅
F5 HTTPS iControl f5
API
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
45
Fortinet FortiOS SSH fortios
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
46
Frequently Asked Questions (FAQ)
The Eclypsium Network Scanner is a single-file executable for each OS. It's distributed
as EXE for Microsoft Windows. For details on how to install the Scanner, refer to the
Installation section.
The Scanner collects the following information from the discovered devices:
Protocol usage depends on Platform configuration. The list of supported protocols is:
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
47
6. Which ports are being checked during scans?
The ports being checked during the scan are remotely configured from the Platform. By
default the scan checks for: 80 (HTTP), 443 (HTTPS), 8080 (HTTP), 8443 (HTTPS), 22
(SSH), 139 (SMB), 445 (SMB)
SNMP is disabled by default. It can be enabled by adding port 161 (SNMP) in the Platform
configuration.
SIP is disabled by default. It can be enabled by adding port 5060 (SIP) in the Platform
configuration.
Target networks are configured per Scanner on the Platform. In general, Corporate
networks will be targeted to be scanned. The configuration includes a mechanism to
avoid scanning non-corporate networks.
8. Does the Network Scanner Software impact the system or consume system resources?
Network Scanner software does not perform resource-intensive operations. The Scanner
software mostly runs network-related tasks to collect data from network devices
Eclypsium Proprietary
© 2022 Eclypsium, Inc. | https://www.eclypsium.com | info@eclypsium.com
48