Claroty CTD v4.2.3 Installation Guide Rev1
Claroty CTD v4.2.3 Installation Guide Rev1
(CTD)
Installation Guide
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3
Rev 1
Revisions
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 2 of 56
Rev 1
Contents
Contents
1 Introduction .................................................................................................................. 5
2 Network Preparation for Claroty CTD Installation.............................................. 6
2.1 Network Setup Procedure .......................................................................................... 6
3 ClarotyOS Wizard [Only Admins]........................................................................... 8
3.1 Quick Installation via ISO........................................................................................... 8
3.2 Deploying via OVA ..................................................................................................... 8
3.2.1 Deployment on VMware vCenter ........................................................... 9
3.2.2 Applying settings from a settings.iso after first boot is already done
...................................................................................................... 12
3.2.3 Add a new hard disk or extend an existing one.................................. 13
3.3 Configuring your IP via a Console using CLI ....................................................... 15
3.4 Configuring your IP via the CTD UI....................................................................... 16
3.5 Installing on AWS ...................................................................................................... 16
3.5.1 Deployment from Scratch ....................................................................... 16
4 CTD Wizard [Only Admins] ................................................................................... 21
4.1 Configuring your Network Settings ....................................................................... 21
4.2 Step 1: Choose Product to Install ............................................................................. 23
4.3 Step 2: Activate the License ...................................................................................... 24
4.4 Step 3: Site Information ............................................................................................. 25
4.5 Step 4: Change Password (for EMC or CTD Site) ................................................. 25
4.6 Step 5: Deployment Configuration.......................................................................... 26
4.6.1 CTD Site: Site Information and Deployment Configuration ............. 26
4.6.2 CTD Sensor: Deployment Configuration ............................................. 28
4.6.3 CTD Sensor Lite: Deployment Configuration ..................................... 29
5 Upgrade Procedure for ClarotyOS ......................................................................... 32
6 Upgrade Procedure for CentOS and RHEL via Commands .............................. 35
7 Backing up and Restoring for ClarotyOS ............................................................. 36
7.1 Backup 36
7.2 Restore 37
7.2.1 Restore Latest ........................................................................................... 37
7.2.2 Upload Backup and Restore ................................................................... 37
8 Backup and Restore Procedure for CentOS and RHEL via Commands ......... 38
8.1 Backing up CTD ......................................................................................................... 38
8.2 Restoring CTD ............................................................................................................ 38
9 Installation Reference ............................................................................................... 40
9.1 Package Contents ....................................................................................................... 40
9.2 Installation Optional Flags ....................................................................................... 40
9.3 Additional Components ........................................................................................... 41
9.4 NTP Usage .................................................................................................................. 41
9.5 Sensor Setup via CLI Commands ............................................................................ 41
9.5.1 Adding a Sensor to a Standalone Site ................................................... 41
9.5.2 Bootstrap & Connect Sensor to CTD Server Connected to EMC ...... 42
9.6 NAT/PAT Mappings ................................................................................................. 43
9.6.2 Extracting PAT data from Ubiquiti Network Management Server
integration .................................................................................. 44
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 3 of 56
Rev 1
Contents
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 4 of 56
Rev 1
Introduction
///////
1 Introduction
This document provides the installation procedure for Claroty Continuous Threat
Detection (CTD), version 4.2.3.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 5 of 56
Rev 1
Network Prepar
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 6 of 56
Rev 1
Network Prepar
///////
7. Compare your asset list with the discovered assets in Claroty. If some assets
are missing, check the communication paths. Maybe you need to install a
sensor or SPAN more VLANs/ports into the CTD monitoring port.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 7 of 56
Rev 1
ClarotyOS Wiza
///////
Note In the first installation, you can opt to change the IP address once.
4. You can reconfigure your network settings by entering the Admin password
and then Run.
Wait until the machine IP is presented.
5. Choose whether you prefer to configure your IP via a console using CLI or
via the CTD UI; then continue to the CTD Wizard.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 8 of 56
Rev 1
ClarotyOS Wiza
///////
2. Optional: a settings.iso file with your deployment settings. This file will be
generated by the Claroty team.
3. Choose how you want to deploy your OVA: via VMware (continue the steps
below) or a using a Cloud platform, such as AWS as described in section 3.5).
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 9 of 56
Rev 1
ClarotyOS Wiza
///////
Continue the wizard and select the name of the VM, the folder, the ESX, and
the storage.
When the wizard is done, you will have the machine powered off in your
folder. DON’T TURN ON THE MACHINE YET!
Right-click on the machine, choose “edit settings”, and configure the VM
CPU and Memory allocation to your needs. You may also increase the size of
the Hard Disk, but you will have to do a manual command later in the
admin shell in order to make the VM see the change admin@localhost#
storage extend-device.
If you don’t have a settings file, you may turn on the machine and configure
it through the ClarotyOS Wizard.
If you have a settings.iso file, before turning the machine on, open the
machine console through “Remote Console”. You may get the installation of
“VMware remote console” from their website if you need it.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 10 of 56
Rev 1
ClarotyOS Wiza
///////
On VMware Remote Console, click the disc icon and select “CD/DVD
Settings”
Check the “Connect At Power On” checkbox. Then click on “Choose a local
disc or disc image” and choose the provided “settings.iso” file. After, you
can close this window.
Now, turn on the machine using the “Power On” button on the top of the
screen:
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 11 of 56
Rev 1
ClarotyOS Wiza
///////
A minute or two after the machine will finish the boot, it will read the
settings from the iso file and apply them. Once the process is done, you will
see a message is the machine console:
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 12 of 56
Rev 1
ClarotyOS Wiza
///////
Note To add the new hard disk via the command line run this command:
storage add-device
Approve:
Approval message:
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 13 of 56
Rev 1
ClarotyOS Wiza
///////
Note If you can’t find the device you have extended in the list please
perform a reboot and try this command again:
Approve:
Approval message:
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 14 of 56
Rev 1
ClarotyOS Wiza
///////
Default password:
For Claroty - “Claroty1!”
For White Label - “Password1!”
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 15 of 56
Rev 1
ClarotyOS Wiza
///////
Prerequisites
A valid username and password.
Approval to use the platform, due to company costs.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 16 of 56
Rev 1
ClarotyOS Wiza
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 17 of 56
Rev 1
ClarotyOS Wiza
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 18 of 56
Rev 1
ClarotyOS Wiza
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 19 of 56
Rev 1
ClarotyOS Wiza
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 20 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 21 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 22 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 23 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 24 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 25 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 26 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 27 of 56
Rev 1
CTD Wizard [On
///////
7. Dump Size – Shows the size of the network traffic file that was recorded.
8. Save Changes – Press when done to commit your settings.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 28 of 56
Rev 1
CTD Wizard [On
///////
Figure 27 Sensor Tab in Settings > Data Sources > Interface Configuration
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 29 of 56
Rev 1
CTD Wizard [On
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 30 of 56
Rev 1
CTD Wizard [On
///////
You have successfully finished installing the sensor. The Sensor Lite tab now
appears in the Interface Configuration page with the relevant properties:
Figure 30 Sensor Lite Tab in Settings >Data Sources > Interface Configuration
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 31 of 56
Rev 1
Upgrade Proced
///////
Note When upgrading the EMC, the EMC Insight operation statuses are
deleted, assuming that the Site statuses are more significant. If
otherwise, contact Claroty Support to retain the EMC Insight actions.
Note Watch the logs to ensure your upgrade was successful. If it failed,
please consult Claroty Support and send the presented logs.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 32 of 56
Rev 1
Upgrade Proced
///////
Note If the service will be restarted during the upgrade, your connection will
be lost for a few minutes.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 33 of 56
Rev 1
Upgrade Proced
///////
Note: The connected sensors will be upgraded by default after the CTD is
upgraded.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 34 of 56
Rev 1
Upgrade Proced
///////
6. The system will ask if you want an upgrade or a clean installation. Choose if
you want to back up the old configuration:
Do you want to upgrade to <new_version #>? [U] or perform a
clean install [C]? : u
8. When you respond ‘yes’, you are prompted to choose a backup directory and
path:
Please choose backup directory: [root]
9. The system asks you to confirm if you are upgrading from a previous
version to the current one, and the backup directory and path:
Upgrading CTD from <current_version #> to <new_version #>,
performing backup in /root. Are you sure? [Y/N]:
10. When you respond ‘Yes’, CTD performs the backup and the upgrade.
11. After installation is successfully completed, the following output appears:
Done – CTD successfully installed
12. If the installation failed, see the install.log file for details.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 35 of 56
Rev 1
Backing up and
///////
7.1 Backup
In this screen you can easily Backup your system in two ways:
Local – Backup the data on your local machine
Remote – Backup your data on a remote machine via the SMB protocol.
Navigate to the Configuration > ClarotyOS > Backup & Restore tab.
Specify the following fields:
Type – for example SMB
Path – the path the file will be saved in
Username – the username of the remote machine
Password – the password of the username you entered
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 36 of 56
Rev 1
Backing up and
///////
7.2 Restore
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 37 of 56
Rev 1
Backup and Res
///////
Example
[root@localhost - ] #cd /opt/icsranger/
[root@localhost icsranger] # ./backup_ranger.sh
Backup target is /opt/icsranger
Done – Backup successfully created
Backup tar: /opt/icsranger/ranger-backup-xxx.xxxxx.tar.gz
Note Migration is limited to cases in which there were no major changes between the
versions. In case of a major change between versions, first install the backup's
CTD version, restore CTD, and then upgrade.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 38 of 56
Rev 1
Backup and Res
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 39 of 56
Rev 1
Installation R
///////
9 Installation Reference
Command Outcome
or
--backup-dir [PATH_TO_DIR]
or
-- upgrade
auto-run
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 40 of 56
Rev 1
Installation R
///////
Command Outcome
or
-- help
The options can be used either by the flags above within the install.sh
command, or by answering the questions.
Note The questions appear when the flags are not used.
Example
./install.sh –no-backup –no-upgrade
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 41 of 56
Rev 1
Installation R
///////
e.g.
lkpocli manager api configurator bootstrap_sensor Sensor
10.10.10.1
In case the password has been changed, there is a need to add the new
password along with the command.
For example, if the password is 123456, the command should be as follows:
lkpocli manager api configurator bootstrap_sensor Sensor1
10.10.10.1 bootstrap_password=123456
Step 3: Verify that the Sensor has been added to the CTD Server
1. Run the following command:
lkpocli community friends
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 42 of 56
Rev 1
Installation R
///////
3. Verify that the site has been added to the EMC by running:
lkpocli community friends
In case the password has been changed, there is a need to add the new
password along with the command.
For example, if the password is 123456, the site IP address is 10.10.10.1
and the name is Sensor, then the command should be as follows:
lkpocli manager api configurator bootstrap_sensor Sensor
10.10.10.1 bootstrap_password=123456
For example:
"TB ROC" 10.185.51.41 4002 192.168.1.2 4002 TCP
Errors in this process will be reported via the console screen and CTD activities.
The system is able to generate the following errors:
CSV file not found
Not enough columns
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 43 of 56
Rev 1
Installation R
///////
Note If a problem occurs with loading a specific record, the system will make
the best effort in parsing the rest of the file.
Note Data is built on a per-site basis, where sensors get their data from their
respective site.
3. After configuration, download from the server can be initiated by using the
following command:
lm nat_translator download_from_server
4. Output would be a CSV file adapted for CTD as input for NAT/PAT
mapping.
5. Another option would be to periodically download data from the NMS
server. This can be started and stopped by using the following commands:
lm nat_translator start_periodic_download
lm nat_translator stop_periodic_download
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 44 of 56
Rev 1
Installation R
///////
9.7.1.1 Configuration
To configure a Kepware-based port allocation:
1. Download the JSON configuration files to a persistent path on the machine
2. Run from the command line:
lkpocli manager api manager set_config kepware_path \
PATH_TO_KEPWARE_FILE_OR_DIRECTORY_OF_FILES
Note Configuration is done on a single site basis - meaning that sensors would
automatically be configured by their respective site.
Note After the configuration has been set, it will be loaded for the specified
file on every startup of CTD.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 45 of 56
Rev 1
Installation R
///////
To use bridges, you’ll first need to create one using network bridge create.
Then, you’re able to configure, and add network interfaces to the newly created
bridge:
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 46 of 56
Rev 1
Installation R
///////
After you generate a bridge, a new bridge instance will be generated without any
interfaces. You can Attach an interface to a bridge by pressing the “Attach to
Bridge” button on the desired interface. (Make sure to press the Update button
first if you changed some settings on that network interface).
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 47 of 56
Rev 1
Installation R
///////
To Install:
1. Go to the upgrade page
2. Upload Tripwire Hardware BNI
3. Run upgrade
4. Reload web page
Web Management
The switches control LAN Bypass and its Watchdog process.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 48 of 56
Rev 1
Installation R
///////
Shell Commands
Enabling/Disabling Watchdog:
plugin tripwire_hardware TIV_BPWD_Control TIV_BPWD_Control -
wdt_s_alone <on|off>
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 49 of 56
Rev 1
Exporting Data
///////
10 Exporting Data
10.1 Overview
The system exports assets to an external database, the External Data Component.
After it is configured, the Export Data Server (EDS) is the CTD component
responsible for exporting the assets.
10.2 Prerequisites
After the Export Data Server is configured, the DB of the supported platforms
should comply with the following requirements.
The Export Data Server is supported on RHEL or CentOS v7.6 (Minimal) or
higher with MySQL database. Alternatively, the Export Data service can be
installed on the Linux machines and the database can be separated into a
different machine on Windows Server 2008 and MSSQL 2012 and higher.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 50 of 56
Rev 1
Exporting Data
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 51 of 56
Rev 1
Exporting Data
///////
OS Text The OS
first_seen datetime The first date and time this asset was
seen in the communication in the
network
last_seen datetime The last date and time this asset was
seen in the communication in the
network
The combination of Central_id, site_id and id creates a UUID that can be used
to uniquely identify an asset.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 52 of 56
Rev 1
Exporting Data
///////
In the database create user with full permissions. The username and password
should be provided to the Export Data server.
Type in the command:
passwd bootstrap.
Note: The password you set for the user bootstrap and the actual bootstrap
password of your EDS must match exactly.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 53 of 56
Rev 1
Exporting Data
///////
Create a community that will be used for the CTD/EMC to establish a connection:
lkpocli community init --name Asset_DB --bootstrap_password
<password. Default is 1234>
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 54 of 56
Rev 1
Exporting Data
///////
Note The columns are configured on the CTD/EMC side, not on the Export
Data side. This allows specific data from specific sites to flow to Export
Data Server.
e. Use reverse SSH tunnel – The default is Yes (uncheck the checkbox if
not relevant)
Limitations:
Manual edits on assets are not pushed via the export data feature.
Assets can only be sent with IPv4.
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 55 of 56
Rev 1
Exporting Data
///////
Claroty Continuous Threat Detection (CTD) Installation Guide Proprietary & Confidential
February 2021 CTD Version 4.2.3 Page 56 of 56
Rev 1