Algosec Security Management Suite: Installation and Setup Guide
Algosec Security Management Suite: Installation and Setup Guide
Algosec Security Management Suite: Installation and Setup Guide
Suite
Software Version: A30.00
View our most recent updates in our online ASMS Tech Docs.
Document Release Date: 1 April, 2020 | Software Release Date: August 2019
Installation and Setup Guide
Legal Notices
Copyright © 2003-2019 AlgoSec Systems Ltd. All rights reserved.
AlgoSec, FireFlow, and BusinessFlow are registered trademarks of AlgoSec Systems Ltd. and/or its affiliates
in the U.S. and certain other countries.
Check Point, the Check Point logo, ClusterXL, FireWall-1, FireWall-1 GX, FireWall-1 SecureServer,
INSPECT, INSPECT XL, OPSEC, Provider-1, Safe@Home, Safe@Office, SecureClient, SecureKnowledge,
SecurePlatform, SecuRemote, SecureXL Turbocard, SecureServer, SecureUpdate, SecureXL, SiteManager-
1, SmartCenter, SmartCenter Pro, Smarter Security, SmartDashboard, SmartDefense, SmartLSM, SmartMap,
SmartUpdate, SmartView, SmartView Monitor, SmartView Reporter, SmartView Status, SmartViewTracker,
UserAuthority, VPN-1, VPN-1 Edge, VPN-1 Pro, VPN-1 SecureClient, VPN-1 SecuRemote, VPN-1
SecureServer, VPN-1 VSX, VPN-1 XL, are trademarks or registered trademarks of Check Point Software
Technologies Ltd. or its affiliates.
Cisco, the Cisco Logo, Cisco IOS, IOS, PIX, and ACI are trademarks or registered trademarks of Cisco
Systems, Inc. and/or its affiliates in the U.S. and certain other countries.
Juniper Networks, the Juniper Networks logo, NetScreen, and ScreenOS are registered trademarks of
Juniper Networks, Inc. in the United States and other countries. JUNOS and JUNOSe are trademarks of
Juniper Networks, Inc.
All other product names mentioned herein are trademarks or registered trademarks of their respective
owners.
The software contains proprietary information of AlgoSec; it is provided under a license agreement
containing restrictions on use and disclosure and is also protected by copyright law.
Due to continued product development this information may change without notice. The information and
intellectual property contained herein is confidential between AlgoSec and the client and remains the
exclusive property of AlgoSec If you find any problems in the documentation, please report them to us in
writing. AlgoSec does not warrant that this document is error-free.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by
any means, electronic, mechanical, photocopying, recording or otherwise without the prior written
permission of AlgoSec Systems Ltd.
Contents
Introduction 7
ASMS products 7
Server installation options 8
ASMS deployment checklist 10
Infrastructure and analytics 10
AlgoSec Firewall Analyzer deployment tasks 11
Network visibility and awareness 12
Intelligent policy change automation 12
Application discovery and management 13
System requirements 13
Hardware minimum requirements 13
Software requirements 15
Networking requirements and recommendations 15
Capacity planning for AFA 18
Sample assumptions 18
Example 1 - Daily analysis of 4 devices, stored one year back 18
Example 2 - Bi-weekly analysis of 50 devices, stored three months back 18
Larger installations with hundreds of devices 19
Prepare an AlgoSec hardware appliance 19
Shipping carton contents 20
Device name mapping 21
Generation 9 technical specifications and elements 21
Generation 10 technical specifications and elements 23
ASMS system security 25
Additional hardening procedures 25
Connecting securely to the AFA server 26
Connecting securely from the AFA server 26
Download ASMS software packages 27
Required software packages per deployment 28
FIPS 140-2 compliance 29
Introduction
This guide describes how to deploy the AlgoSec Security Management Suite (ASMS),
upgrade to new versions, or reconfigure deployment options on existing environments.
l ASMS products
ASMS products
ASMS installations can include the following products, depending on your license:
AlgoSec Analyze security devices across your network, including both on-
Firewall premises and cloud devices.
Analyzer (AFA)
An ASMS environment can use AFA alone, AFA with FireFlow, or AFA with both
FireFlow and BusinessFlow. Each product in use must be enabled on the ASMS
license.
AlgoSec also provides the following additional software for use with ASMS:
AlgoSec Provides quick access to core ASMS functionality and data from
AlgoBot the comfort of your existing chat platforms, including desktop, web,
and mobile options.
For more details, see AlgoBot: The First Intelligent Chatbot for
Network Security Policy Management.
AlgoSec AlgoSec can provide you with hardware appliances that are pre-
Hardware installed with AlgoSec software.
Appliances No software installations are required for the initial setup, although
you may need to perform upgrades for new versions.
For details, see Deploy standalone appliances.
Virtual AlgoSec can provide you with a pre-installed VM image for you to
Appliances deploy on your own system.
No software installations are required for the initial setup, although
you may need to perform upgrades for new versions.
For details, see Deploy standalone appliances.
Advanced options
Advanced server configuration options include:
l Distributed architectures
Load Increase computing power with slave machines that are managed
distribution by a master AlgoSec appliance.
In this configuration, all slaves must be in the same geographical
location as the master appliance.
For more details, see also Download ASMS software packages and ASMS system
security.
For details not included in this guide, see the online ASMS Tech Docs.
Step Description
Environment View your network map in AFA and confirm that it displays as
visibility and expected.
accuracy
validation
Step Description
Step Description
Network topology After viewing default reports and query results, you may
modeling & adjustment want to adjust the way AFA displays your data.
Step Description
FireFlow sanity- Create a sample change request and push it through the entire
check request workflow to test each step in the process.
Step Description
BusinessFlow sanity- View data for your application from BusinessFlow to test
check application each feature.
System requirements
ASMS's system requirements include the following:
l Software requirements
These requirements apply for both active and standby nodes, and on standalone
systems, Central Managers, and geographic or load distribution agents.
Hardware Required
CPU 4 cores
Memory 16 GB
Storage 300 GB
Note: These minimum requirements suffice for initial demo and testing environments,
such as for up to 50 simple devices. For details about final sizing calculations for
production environments, contact your AlgoSec partner or sales engineer.
Configuration Description
NAS storage If you configure AFA to store all reports on a remote NAS server, this
will impact where the storage space is needed.
For details, see Configure NAS storage.
HA/DR Each node in an HA/DR cluster must be identical, including the same
clusters type of installation (AlgoSec hardware or VM appliance), and have
the same amount of disk space.
For details, see Manage clusters
Configuration Description
Software requirements
ASMS requires the following software, depending on your deployment method:
Deployment Requirements
Virtual appliances ASMS can be deployed on virtual machines that use VMWare
ESX versions 5.5 and higher.
For more details, see the Support page on the AlgoSec portal.
l System requirements
For more details, see Manage clusters and Configure a distributed architecture.
ICMP ✔ ✔ ✖ ✔
SSH TCP/22 ✔ ✔ ✖ ✔
HTTPS TCP/443 ✔ ✔ ✖ ✔
syslog UDP/514 ✖ ✖ ✖ ✔
hazelcast TCP/5701 ✔ ✖ ✔ ✔
activemq TCP/61616 ✔ ✖ ✖ ✔
postgrsql TCP/5432 ✔ ✖ ✖ ✔
postgrsql TCP/5433 ✖ ✖ ✖ ✔
additional port
HA/DR TCP/9595 ✖ ✖ ✖ ✔
Tip: The faster your network speed, the faster your clusters will be completely
synched.
Requirement Description
Email Enable access from AFA and FireFlow to the mail server via SMTP
access and POP3/IMAP4
Device Enable access from the Central Manager, any high availability
access standby nodes, and Remote Agents to devices via SSH, OPSEC,
REST, or SNMP (as needed)
â See also:
The following examples may help you to determine the storage capacity you require.
Sample assumptions
The examples in this section assume an average report size of 75 MB, which is a typical
report size in an enterprise environment.
However, in cases of extremely large devices, report size can reach hundreds of MB.
Reports for specific device brands, such as Check Point, are generally larger than 75
MB.
In this situation, AFA reports will consume 75 MB x 4 = 300 MB per day. 7 x 4 x 75 = 2.1
GB per week.
If the analysis time is 10-30 minutes per device, with a 20 minute average, the daily
analysis will typically run for 1 hour and 20 minutes.
In this case, we'd set AFA to analyze upon install, and configure the system to delete
reports that are older than 3 months old, keeping a single report for each of the previous
periods.
AFA will generate about 2 x 13 reports in a 3-month period, plus three representative
reports from each previous quarter. this results in about 30 reports, per device, per year.
The calculation for the required disk space is: 50 x 75 MB per report x 30 reports = 112
GB for the entire year.
If the analysis time is 10-30 minutes per device, with a 20 minute average, the total
analysis calculation is:
To avoid analysis batches that overlap in time, ensure that AFA has enough time to run
the full analysis. Since we have a 5-hour analysis, we'll schedule the next analysis to
run at least 7 hours after the start of the previous one.
Do the following:
2. Mount the appliance on the rack, with the AlgoSec logo facing front.
3. Connect one end of the power cable supplied to the power jack on the appliance's
5. Remove the bezel from the front panel, and press the Power On button.
Two power cables Only one power cable is needed for 2062 appliances.
Two network cables Only one network cable is needed for 2062 appliances.
Note: iLO provides additional features for controlling and maintaining the appliance.
For 2062 appliances, you may want to contact HPE to acquire an iLO license. For
more details, see the HPE iLO documentation.
For example, a physical device might be named NIC1. The OS would be ETH0.
Element Description
Video connector.
USB ports.
Health LED.
Element Description
Power Two power jacks for supplying power to the appliance (that is, redundant
jack PSUs).
Video connector
Element Description
Dimensions 4.29 x 43.46 x 70.7 4.29 x 43.46 x 70.7 4.29 x 43.46 x 70.7
(HxDxW) cm cm cm
1.69 x 17.11 x 27.83 1.69 x 17.11 x 27.83 1.69 x 17.11 x 27.83
in in in
CPU 6 cores: Intel Xeon 20 cores: Intel Xeon 40 cores: Intel Xeon
Bronze 3104 Silver 4114 Gold 6138
Element Description
Video connector.
USB ports.
Health LED.
Element Description
Power Two power jacks for supplying power to the appliance (that is, redundant
jack PSUs).
Element Description
Video connector
We use standard vulnerability scanners, customer feedback, as well as our own security
expertise to create, run, and make updates to this hardening procedure.
To ensure maximum security, make sure to routinely install any security patches
released by AlgoSec. These security patches may include updates for AlgoSec Firewall
Analyzer, FireFlow, BusinessFlow, as well as appliance package updates.
l Place the AFA server in a special zone behind one of your devices.
l Write very restricted policy rules to control access to the AFA server.
l Install valid certificates properly signed by a certificate authority, replacing the pre-
installed, self-signed certificates that are provided by default on AlgoSec web
servers.
For more details, see How to Install and Generate an SSL key and Certificate
Signing Request (CSR) KB article on AlgoPedia.
When configuring external firewalls for your ASMS system, see the following sections:
Performing hardening procedures on your own may render your AlgoSec system
inoperable and void your support contract.
AFA sends the following outgoing requests, which require no open, listening ports:
Request Description
Request Description
POP mail retrieval Email retrieval via "fetchmail" over POP3 must be
accessible, if configured (TCP/110).
SSH device If you want to enable remote access to the AFA server, we
communication recommend using SSH. Ensure that port TCP/22 is
accessible.
Note: AFA will send additional requests via interfaces that differ depending on your
device types.
Do the following:
Major When upgrading to a major version, you must download the Appliance
version build and the software builds for all active products, even if they are not
upgrades included in your license.
Product activation is as follows:
l AFA is always active.
l By default, FireFlow is inactive, and BusinessFlow is active.
FireFlow is activated when FireFlow is deployed.
l Using an appliance as a Remote Agent or Load Slave automatically
deactivates both FireFlow and BusinessFlow. FireFlow and
BusinessFlow are installed, but are not active on Remote Agents or
Slaves, and therefore only require the Appliance and AFA build
files.
l FireFlow and BusinessFlow can also be deactivated manually.
Hotfix If you are upgrading to a hotfix version, the build files required will
upgrades depending on the content of the hotfix.
Note: For details about native Linux installations, see Deploy or upgrade a
standalone native Linux server in AlgoPedia.
Warning: Using this mode of Appliance build is irreversible. Once the FIPS package
is running on your system you must use FIPS installation packages for all future
upgrades.
Note: Each installation package includes software for the full AlgoSec Security
Management Suite. Functionality for each ASMS product is enabled via license, and
not by installation.
Do the following:
6. Test your installation. For details, see Test machine installation and configuration.
7. Set up your environment. For details, see Set up the ASMS environment.
Note: Each installation package includes software for the full AlgoSec Security
Management Suite. Functionality for each ASMS product is enabled via license, and
not by installation.
Both nodes must run the same version of ASMS, and must have the same amount of
disk space.
Do the following:
Note: If you are reusing an appliance in a new role, you must re-set it to it's
factory defaults.
For example, you might do this if you appliance was previously used as a
Central Manager, and you now want to use it as a Load Slave or Remote
Agent.
For details, see Reset the appliance to factory defaults and Switch appliance
roles.
HA clusters Configure NAS storage for the primary node of the cluster.
The cluster building process automatically configures NAS on
the secondary HA node.
DR clusters If you want NAS on both nodes, you must configure NAS on both
nodes. In order to achieve this, you must provide a second NAS
server at the disaster recovery site.
Load Configure NAS for the master appliance only. NAS will
distributions automatically be configured for the load slaves.
one another.
6. If you are deploying clusters, build and configure the clusters. For details, see
Manage clusters.
7. Test your installation. For details, see Test machine installation and configuration.
Slaves and Remote Agents do not need their own licenses installed.
10. If you are deploying a distributed architecture, configure the distribution. For
details, see Configure a distributed architecture.
11. Perform sanity checks. For details, see Basic sanity checks.
12. Continue to deploy ASMS products, including populating your environment with
devices and users. For more details, see ASMS deployment checklist.
â See also:
l Introduction
l ASMS licensing
l General system maintenance
Note: Each installation package includes software for the full AlgoSecSecurity
Management Suite. Functionality for each ASMS product is enabled via license, and
not by installation.
l Ensuring that your AWS instance includes high performance storage, such as
SSD disks
Do the following:
1. Deploy your AWS AMI. For details, see Download ASMS software packages.
The AlgoSec AMI is shared with your account. When the setup process is
complete, you are notified and provided with the details required to access your
new instance with ASMS.
Do the following:
You may need to unlock the root user before logging in. If so, run:
If you are deploying clusters or distributed architectures, continue with Deploy clusters
and distributed architectures.
Note: Converting a VHD file to an Azure image has a variety of options and methods.
Use the steps described below when deploying your ASMS installation to prevent
unexpected errors.
Do the following:
Resource Under the Resource Group field, click Create new to create a
Group new resource group.
Enter a meaningful name for your new resource group, such
as ASMS-Deployment.
For example:
Continue in the wizard to create the new storage account and wait while it's
deployed.
2. Once the new storage account is deployed, navigate to the Storage accounts
area, and click the new storage account to view details.
3. In your new storage account, click Containers, and then to add a new
container.
Define your new container with a meaningful name and a Public access level of
Private (no anonymous access).
For example:
4. Switch to the Azure CLI, and ensure that the PowerShell Az module is installed.
For more details, see Set-ExecutionPolicy and Install the Azure PowerShell
module in the Microsoft documentation.
Connect-AzAccount
6. Copy the VHD file downloaded from the AlgoSec portal to your Azure resource
group.
In this command, replace <VHD_NAME>.vhd with the exact name of the file you
downloaded.
Note: While the VHD that AlgoSec provides is dynamic, and the Azure requires
a fixed hard disk, the upload process converts the dynamic file to a fixed file
format.
Additionally, while you can convert this dynamic file to a fixed file manually, this
requires a very large upload, and also runs the risk of errors. We recommend
using the commands provided here to perform this upload.
7. Return to the Azure portal to create your image. Navigate to Images, and click
.
Resource Select the new resource group you created for ASMS.
group
Storage blob Click Browse, and navigate to the VHD you uploaded via the
CLI.
For example:
8. Navigate to the Azure Virtual machines area, and click to create a new
virtual machine.
Username / Enter the credentials you want to use when accessing the new
Password virtual machine.
For example:
9. Click Next: Disks > to continue, and then select Standard SSD.
10. Continue through the wizard to create your virtual machine with ASMS installed.
When you're done, log in to your machine to deploy and set up your ASMS system.
Continue with step 3 above.
â See also:
l Introduction
l ASMS licensing
l General system maintenance
Do the following:
b. Log in using the username and password printed on the sticker on top of the
hardware appliance.
For more details, search this guide for the relevant procedure.
Do the following:
l Configure DHCP
Note: If you are working with clusters, and you change the IP address for an
HA cluster, you must re-build the cluster afterward.
NAS storage support
ASMS supports NAS storage configurations as follows:
Support Description
Support Description
DR clusters Secondary nodes can have their own NAS server at the disaster
recovery site.
In such cases, customers are responsible for configuring the
communication synchronization between the NAS servers at the
primary and disaster recovery sites.
Do the following:
1. Log on to the NAS server, and create a new directory in a shared space.
2. Connect to the Administration interface on your ASMS machine. For details, see
Connect to the Administration Interface.
3. Enter 11 to configure NAS. The system confirms that NAS is not configured.
4. Enter 1 to set NAS for storing system reports. The system displays a message
similar to the following:
You are about to configure a NAS server for storing system reports.
Note: No changes will take place without your final approval.
Before adding NAS configuration, your reports will be copied to the
following directory: algosec/firewalls_back_algosec/groups_back
algosec/matrices_back algosec/fwfiles_back
Once NAS configuration completes successfully, you may copy the data
back to the original directories.
6. Enter the NAS mount path. This is the directory that you created on the NAS
server in step 1.
The system confirms by displaying the NAS configuration IP, mount path, and
NFS version.
For example:
Tip: If you specifically want to use NSFv3, change the NFS version manually.
If there is already content present in the mount path directory, the system prompts
you to continue with one of the following:
If you have load slaves configured, the system configures NAS on the load slaves
as well.
NAS configured successfully
Do the following:
2. Connect to the ASMS machine's Administration Interface. For details, see Connect
to the Administration Interface.
3. Back up your data by copying the reports from the mounted NAS directory. For
example, copy the files from algosec/firewalls algosec/groups algosec/matrices
algosec/fwfiles to a backup directory at algosec/firewalls_back_algosec/groups_
back algosec/matrices_back algosec/fwfiles_back.
The system displays the NAS configuration details, and prompts you to select
whether you want to check the NAS connectivity status or remove the NAS server.
The system prompts you to confirm that you want to remove the existing
configuration.
6. Enter y to confirm.
NAS is removed from any slaves, as needed. When NAS is fully removed, the
following message appears:
7. Copy your reports to your production directories and remove them from the remote
NAS server.
Do the following:
Open a browser, and browse to IP address of your AlgoSec machine.
If the AlgoSec home page appears, your machine is connected and configured correctly.
For example:
If this page or another like it does not appear, check to see that your basic configurations
have been done correctly. For details, see Perform basic configurations.
Manage clusters
ASMS clusters prevent data loss and downtime in the event of hardware failures. Virtual
Appliances and AlgoSec Hardware Appliances support both high availability and
disaster recovery clusters.
Note: If you have both ASMS deployed on virtual machines and also AlgoSec
Hardware Appliances in your system, each cluster must have nodes of the same
type: hardware-hardware or VM-VM. Clusters are not supported on Native Linux
server installations.
l Build a cluster
l Break a cluster
By default, the primary appliance is active, and the secondary appliance is in standby
mode.
The primary and secondary appliances regularly verify that they can communicate with
each other and that the other is alive. In the event that the primary appliance goes down,
the secondary appliance will become active, in an event called failover.
Ping nodes are used to determine whether the primary appliance is connected to
the network. If a ping to the node that represents the primary machine fails, the
network connection on the primary appliance is considered to be down, triggering
a failover to the secondary appliance.
l Both nodes are located at the same site and are physically connected.
This prevents a situation called split-brain, where failover might occur when the
primary appliance is actually still active, such as if a ping from the primary
appliance fails to reach the secondary appliance due to networking issues only.
This ensures that if or when failover occurs, AlgoSec services remain available at
the same IP address.
AFA In HA clusters, the AFA database is fully active only on the secondary
node, and partially active on the primary node.
The secondary node also offers both read and write capabilities, while the
primary node offers only read capabilities.
In most cases, this does not affect your appliance configuration.
The appliance nodes are located at different sites. If a primary appliance fails, the
secondary appliance must be put into active mode manually. This is called manual
failover, or switching appliance modes.
Build a cluster
This section describes how to build an ASMS HA or DR cluster, starting with the primary
appliance. Data from the local or primary appliance is copied to the secondary or remote
appliance during the build process.
Note: The amount of time the build process requires is dependent on the size of the
database and the monitoring directory, and may be significant.
Important: For HA clusters, you must not make any changes to the iptables service.
This service is crucial to the communication between the nodes, and any manual
changes may compromise the environment.
Do the following:
For example:
Note: You do not need to configure an IP address on the second interface. This
will be configured when you build the cluster.
Do the following:
Tip: Connecting via network cable helps to ensure that failover does not occur
due to network connection issues.
2. From the appliance that will be the primary node, connect to the ASMS
Administration Interface. For details, see Connect to the Administration Interface.
4. Enter the number for the option you want to continue with, and then continue with
the wizard as prompted. The primary appliance is always the local machine.
A summary of the primary and secondary appliances' information appears and you
are prompted to confirm the details.
The system begins to build the cluster. This may take some time, depending on
the amount of ASMS data.
When complete, a success message appears with the cluster status, and an email
confirmation is sent to the administrator email.
second time.
7. If your machine is now part of an HA cluster, you'll need to update the appliance's
IP address in other systems that send data to ASMS. For example, if you
previously had this set to a specific IP address, you'll need to change this to a
virtual IP address.
Note: Report synchronization from the primary appliance to the secondary appliance
is based on NAS configuration. Reports are only synched to the secondary
appliance is NAS is not configured.
Changing parameter values must be done from the primary appliance only. Viewing
parameter values is supported from either the primary or secondary appliance.
Do the following:
1. From the primary appliance, connect to the ASMS Administration Interface. For
details, see Connect to the Administration Interface.
2. In the Administration Interface, enter 13. A prompt similar to the following appears:
Cluster status:
* VIP - 10.10.10.18
The parameters and their current values are displayed, and the system asks
whether you want to make any changes.
Each parameter appears, with the option to change the value. Make your changes
as needed for each parameter, until a confirmation message appears.
Note: When automatic failover is configured, if a ping does not arrive from the
primary appliance within the configured Failover Over Timeout value, the
secondary appliance automatically becomes active.
Your changes are applied, and a success message appears, along with the
cluster status. A confirmation email is also sent to the Administrator user.
Break a cluster
This topic describes how to break a cluster. Removing an appliance from a cluster
changes it to a standalone appliance, and also temporarily stops any AlgoSec services
running on the appliance.
Do the following:
1. From the primary appliance, connect to the ASMS Administration Interface. For
details, see Connect to the Administration Interface.
2. Enter 13. The console displays details about the cluster, including primary and
For example:
Cluster status:
* VIP - 10.10.10.18
AlgoSec services are stopped and the appliance is removed from the cluster.
When complete, the services are started again, and a success message appears
along with the cluster status. An email notification is also sent to the Administrator
user.
4. After breaking a cluster, make sure to bring down one of the appliances that used
to be in the cluster. This is required to prevent duplication, as both appliances
remain connected to the same Slaves / Remote Agents, as well as devices and
firewalls.
Do the following:
1. Connect to the ASMS Administration Interface. For details, see Connect to the
Administration Interface.
You can perform this procedure from either appliance, unless the primary
appliance is already down.
2. Enter 13. The console displays details about the cluster, including primary and
secondary nodes and their statuses.
For example:
2. Secondary 10.10.0.102 - Up
* VIP - 10.10.0.103
2. Remove HA configuration
3. Switch roles
5. Collect Logs
The manual failover begins. Data from the primary appliance is synchronized to
the secondary appliance, and the secondary appliance becomes active.
When the process is complete, a success message appears, with the cluster
status. An email notification is also sent to the Administrator user.
Split-brain situations
If you've received an email notification that a split-brain situation was detected, do the
following:
2. Examine any FireFlow tickets and AFA reports on each appliance, and determine
which appliance has the most recent data.
3. Re-build the cluster from the appliance with the most recent data. For details, see
Build a cluster.
To resolve this issue, configure synchronizations to run less frequently. For details, see
Configure HA/DR parameters.
l If there is less than 10% of disk space found on the Primary data partition.
In this case, a warning message will have been sent by email and to the Issues
Center when the Primary was found to have less than 20% free disk space.
In this case, a warning message will have been sent by email and to the Issues
Center when the secondary node had been unresponsive for 6 hours.
When the node is removed, the Central Manager is left as a single-node cluster.
To continue with your cluster, first handle your disk space or connectivity issue, and
then re-build the cluster as follows:
Disk space If your node was removed for a disk space issue, do the following:
issues
1. Log in to the Central Manager and access the Administration
menu.
2. Enter 13 to re-build your cluster and enter the details for your
secondary node.
For more details, see Connect to the Administration Interface and Build
a cluster.
Connectivity If your node was removed for a connectivity issue, when the secondary
issues node is available again, it will still be configured to send data to the
primary node.
Do the following:
Note: Before you start, we recommend gathering any logs you may need before they
are overwritten as the cluster configuration is removed.
Do the following:
If you are recommended to forcibly remove a node from a cluster, do the following:
1. Log in to the node you want to remove and access the Administration (algosec_
conf) menu.
Note: This option appears only when the system detects that an error has
occurred.
If this option does not appear, you might be trying to break the cluster using the
standard procedure. For details, see Break a cluster.
4. Repeat steps 2-4 on all nodes in the cluster, including the Central Manager.
For more details, see Connect to the Administration Interface and Build a cluster.
2. In the HA/DR sub-menu, select Collect HA logs. This is option 3 when there is no
cluster configured and option 5 when a cluster is configured.
A *.tar file containing all of the relevant logs will be created in the appliance’s /tmp
library.
If you are setting up AFA only, install your licenses as part of the procedure to Define the
first ASMS Administrator. If you are setting up both AFA and FireFlow, install your
licenses after both procedures are complete.
Do the following:
Contact your local network administrator for this value. For more details, see AFA
server DNS name / IP address recommendations .
Tip: If a warning message about the Web server's certificate appears, click
Accept or OK, depending on your browser and security settings.
2. In the Configure the First Administrator dialog, enter the following values:
E-Mail Enter the email address you want ASMS to use to contact the
Address administrator.
Since this is your first login to ASMS, a message appears to notify you that you
don't have any devices defined yet.
l Click the Devices Setup page link to start defining devices immediately.
l Click OK to close the window and install a license. In the Welcome dialog
that appears, click Install License.
License installation
While you can define devices immediately, you cannot run an analysis until you
install a license. If you are also setting up FireFlow, install your license only after
that procedure is complete. For details, see:
l ASMS licensing
Do the following:
2. Log in as user: root
If you are working with a virtual appliance or an AlgoSec Hardware Appliance, the
default password is algosec.
3. Access the Administration Interface (the algosec_conf menu). For details, see
Connect to the Administration Interface.
Device rule AFA and FireFlow are configured to use the following regular
comments expression in all device rule comments:
FireFlow #<ticket ID>
Log in to ASMS to continue your configurations. For details, see Logins and other
basics.
For more details, see Deploy clusters and distributed architectures and Manage
clusters.
Reports are stored on the Master Appliance only. Additionally, access the AFA web
interface via the address of the Master Appliance only.
Do the following:
1. Log in to AFA from the appliance you want to define as the Master Appliance. For
details, see Logins and other basics.
3. In AFA, add each slave, and then add the new IP addresses to the AFA database.
For details, see Add or edit Load Slaves.
View the status of each analysis and the slave it's running on, in the Analysis Status
page in AFA. To view this, click the Analysis Status button next to the user menu.
For example, if the Master Appliance has 8 cores, 4 of them will be used for the Slave
Appliance.
The Central Manager manages the Remote Agents, and can also act as a Remote
Agent for any co-located devices.
Reports are stored on the Central Manager only. Additionally, access the AFA web
interface via the address of the Central Manager.
Do the following:
1. Log in to AFA from the appliance you want to define as the Central Manager. For
details, see Logins and other basics.
3. In AFA, add each Remote Agent appliance. For details, see Add or edit Remote
Agents.
Note: ASMS also supports high availability configurations for remote agents.
Upon failover, the master remains connected to the cluster node that is currently
active. For more details, see Manage clusters.
Two devices in the same AFA environment that are manged by different Remote
Agents, cannot have the same name.
â See also:
l Networking requirements and recommendations
l Delete Load Slaves or Remote Agents
l Disable distributed processes
Do the following:
1. Ensure that you are logged in to AFA as an administrator user. For details, see
Logins and other basics.
2. In AFA, click your username at the top right, and select Administration.
When you're done, continue with Add or edit Load Slaves or Add or edit Remote
Agents, depending on the architecture type you're configuring.
Do the following:
1. Ensure that you are logged in to AFA as an administrator. For details, see Logins
and other basics.
l To edit an existing Slave, click on the relevant row, and click Edit.
Linux User Read only. The username of the Linux user you used to install
AFA on the Slave.
Appears only when adding a new Slave.
5. Click OK.
6. If you added a new Slave, reconfigure the distributed architecture on all slaves. Do
the following:
If you added a new Slave, AFA attempts to connect to it. The Connected column on the
ARCHITECTURE tab indicates whether this connection is successful. Connection
statuses are indicated by the following colors:
l Green. Successful
l Red. Failed
l Grey. In progress
Note: If this is the first Slave that you've added, the number of CPU cores used by the
Master Appliance for running analysis is reduced by half, since the other half is now
used by the Slave.
â See also:
l Delete Load Slaves or Remote Agents
l Disable distributed processes
If you are adding an HA cluster of appliances as a Remote Agent, you must first build
the cluster. For details, see Manage clusters.
Do the following:
1. Ensure that you are logged in to AFA as an administrator. For details, see Logins
and other basics.
l To edit an existing Remote Agent, click on the relevant row, and click Edit.
Name Enter a unique name for the Remote Agent. Read-only when
editing.
Linux User Read only. The username of the Linux user you used to install
AFA on the Remote Agent.
6. Click OK. If you added a new Remote Agent, AFA attempts to connect to it.
l Green. Successful
l Red. Failed
l Grey. In progress
Tip: If you are building a high availability architecture on two remote agents, continue
by building a cluster.
â See also:
l Delete Load Slaves or Remote Agents
l Disable distributed processes
Do the following:
1. Ensure that you are logged in to AFA as an administrator. For details, see Logins
and other basics.
4. Select the row for the Slave or Remote Agent you want to delete, and click Delete.
Note: After removing a load slave or remote agent from your environment, do not use
it again for ASMS without restoring factory settings.
â See also:
l Configure a distributed architecture
l Disable distributed processes
Do the following:
1. Ensure that you are logged in to AFA as an administrator. For details, see Logins
and other basics.
â See also:
l Configure a distributed architecture
l Disable distributed processes
These sanity checks also define standards for basic ASMS functionality, and enable
you to verify that your environment is functioning as expected.
Product Description
Product Description
Do the following:
Output similar to the following should appear, confirming that all of these services
are running:
|======================================|
| 147.172.44.40 |
| |
Do the following:
b. Define a user with permissions for all devices. Specify that the user receives
email notifications for all reports and configuration / policy changes.
a. Define a new device and assign a user with permissions for it, or use an
existing device to test AFA functionality.
c. Verify that all sections of the new report have valid results.
In the report, on the Policy Optimization tab, in the Rule Usage Statistics
area, click All Rule Usage.
Check the first text line to verify that the report is based on logs collected
today.
b. Wait for the next monitoring cycle to run. By default, this runs every 20
minutes.
c. View the device's Monitoring tab and verify that the change was detected.
a. Check that the user you defined back in Prepare for your test receieved an
email alert about the analysis completed in Test device definition and
analysis.
b. Check that the same user received an alert about the change you made to
the device in Test change monitoring.
Do the following:
a. Locate one of the change requests you created in Test change request
submission , and move it through the various stages of the workflow.
l Initial Plan: Shows the relevant devices for the change request.
c. When you get to the Work Order stage in the change request, implement the
change on the device.
d. After the next monitoring cycle is complete, browse to the Validation stage of
the workflow, and verify that accurate validation results are shown.
e. In AFA, run an analysis on the device. Wait 2 hours, and then browse to the
AutoMatching FireFlow stage, and verify that the change request and
change are listed in the correct section.
Do the following:
a. Create a new application, and add flows to it. Add at least one flow that is
currently blocked by the organization's firewalls.
b. Verify the connectivity for each flow, and that the connectivity of the entire
application updates automatically.
c. In the Change Requests tab, verify that a change request was created for the
new flows.
c. Verify that the relevant change requests were opened to drop the
application's traffic.
Note: If the application contains flows that are in use by other applications, change
requests for this traffic will not be opened.
l AlgoSec FireFlow User Guide. Describes how to add unprivileged users, also
known as Requestors, to FireFlow.
When FireFlow and BusinessFlow are licensed, users added to AFA automatically
have access to FireFlow and BusinessFlow, and FireFlow Requestors automatically
have access to BusinessFlow.
Upgrade ASMS
This section describes how to upgrade an ASMS environment to a new version of
ASMS.
l Upgrade prerequisites
After upgrading, we recommend running a manual group report for the ALL_
FIREWALLS group so that you can view all features.
Upgrade prerequisites
Before you start upgrading your ASMS system, read through the following prerequisites
and ensure that you and the system are ready to start.
In this section:
If you have an ASMS version earlier than 2018.1, you must first perform any upgrades
required to get to 2018.1. For details, see the upgrade procedure in the Installation and
Setup Guide for 2018.1 or any other version you are upgrading to. These guides are
available from the AlgoSec portal.
Note: Prerequisites and upgrade procedures will differ, depending on your system
version.
Example: If you are upgrading from 6.11 to 30.00, perform two upgrades:
1. First, upgrade from 6.11 to 2018.1. Use the procedure in the 2018.1 Installation
and Setup Guide.
2. Then, upgrade again from 2018.1 to 30.00. For more details, see Upgrade your
system.
l If less than 5 GB of disk space is found, the upgrade process aborts.
l If there is less than 10 GB of disk space found, the upgrade process presents a
warning and enables you to choose whether to continue or not.
To cancel and run the upgrade later, enter n at the confirmation prompt.
If you are upgrading from 2018.2, these steps are not required.
If you have un‐applied workflow changes in VisualFlow, we recommend that you apply
them before upgrading so that you don't lose any work.
l psql
l metro (apache-tomcat)
l mongod
If these services are not running, the upgrade process requests that you confirm whether
you would like to continue. We recommend contacting AlgoSec customer support to
start these services before continuing.
Note: Before you start, review the upgrade prerequisites and ensure that your system
complies. For details, see Upgrade prerequisites.
Do the following:
1. Upgrading from 2018.1 only: If you are upgrading from 2018.1 and have NAS
configured, first deconfigure NAS before you upgrade. For details, see
Deconfigure NAS storage.
2. Determine the builds that you need to upgrade, and download the relevant
software packages from the AlgoSec portal. For details, see Download ASMS
software packages.
Clusters / distributed nodes: Access the primary node on the Master / Central
Manager appliance.
Note: The system checks your pre-requisites to verify that your system is ready
for the upgrade. If any of the pre-requisite checks fail, relevant errors are
displayed to notify you. In such cases, we recommend making changes so that
your system complies, and then starting the upgrade process again.
The system lists the available builds from the files you saved in step 3, and
prompts you to select the build you want to install. For example:
************************************
*** Software upgrade is starting ***
************************************
Select an AlgoSec build to install:
1. algosec-appliance-3000.0.0-529-el6.x86_64.run
2. fa-3000.0.0-891.x86_64.run
3. Run All
Run each Enter the line number for the build you want to install. When
installation each upgrade is complete, start the process again to run the
separately next installation. If you do this, install the builds in the
following order:
a. Appliance build
b. AFA build
c. FireFlow
d. BusinessFlow build
The system displays details about the upgrade it is about to perform, and prompts
you to approve.
For example:
If you are working on a distributed system, the upgrade first starts on the local
node and then continues with the distributed nodes. The system displays
confirmation details as the downloaded packages are copied to the distribution
nodes and installed.
When the upgrade is complete, any clusters are resumed if relevant, and the
following message appears:
9. In case of a kernel upgrade on an appliance build, the system also prompts you to
reboot. Reboot your system as prompted.
Warning: Not rebooting at this stage leaves you with a legacy kernel, which
may present security issues.
10. Upgrading from 2018.1 only: If you had deconfigured NAS before you started,
reconfigure it. For details, see Configure NAS storage.
The system also prompts you with options to start the upgrade again.
If you have a distributed system and only some nodes failed, you can select the nodes
you want to reinstall, or rerun the entire upgrade from scratch. Select the option that
works best for you and run through the CLI process as prompted and described above.
Note: Perform a graceful shutdown and restart of the ASMS services to prevent
unexpected behavior. For details, see ASMS graceful shutdown and startup in
AlgoPedia.
Do the following:
1. Connect to the ASMS Administration Interface. For details, see Connect to the
Administration Interface.
reboot
If needed, Hardware Appliances can also be rebooted by pressing the power button on
the front panel of the appliance for 10 seconds, and then pressing it again. We do not
recommend this method as part of regular operation.
For example, you might do this if you appliance was previously used as a Central
Manager, and you now want to use it as a Load Slave or Remote Agent.
Note: Resetting the appliance to factory defaults erases all of the information on the
appliance, including configurations, user data, and so on, and returns it to its initial,
out-of-the-box state.
Do the following:
2. Connect to the ASMS Administration Interface. For details, see Connect to the
Administration Interface.
reboot
4. When the appliance reboots and a message appears, press SPACE. Do this
within 5 seconds to prevent the appliance from fully rebooting.
5. Use the arrow keys to select Restore to Factory Defaults, then press ENTER.
6. Enter erase.
The system is formatted and re-installed, and all data is deleted. This process can
take several minutes.
8. Continue by configuring your machine again. For details, see Configure ASMS
machines.
Do the following:
3. Complete the fields and submit the ticket. Make sure to attach any relevant logs:
l HA logs, if the case relates to high availability issues. For details about
collecting these logs, see Collect logs for AlgoSec technical support.
â See also:
l Backup and restore
l ASMS licensing
This topic describes how to start a backup or restore process from FireFlow or
BusinessFlow. The actual backup and restore is handled by AlgoSec Firewall Analyzer.
Starting from FireFlow or BusinessFlow switches you to AFA to complete the process.
Version You can only restore ASMS to the same major version from which the
backup was taken.
If you have upgrades to perform, upgrade your system only before the
backup or after the restore. Do not attempt to upgrade your system
between backup and restore processes.
System Restoring your system requires some downtime. Disable any jobs
processes scheduled to run during the restore process, such as ASMS
monitoring or analysis.
Reinstate the scheduling once the restore is complete.
Note: After performing a restore, you must run a report on 'All Firewalls' to ensure a
valid network map.
ASMS licensing
This topic describes how to obtain and install ASMS licenses, as well as track license
usage across your devices.
AlgoSec licenses control the AFA modules available, whether FireFlow, BusinessFlow,
or AutoDiscovery are available, the number of routers supported, and more.
l Obtain a license
l Install a license
l License usage
l Update licenses
AlgoSec Licensing: Watch to learn about the ASMS license types available.
Obtain a license
Do the following to obtain a new license key:
Field Description
Field Description
Internet Select whether your AFA server can connect to the internet
Connection while activating the license.
For details, see Online license requirements.
AlgoSec Server Enter the MAC address of your AFA server. To find the
MAC Address MAC address, do the following:
a. Browse to https://<AFA_server>/algosec/, where
<AFA_server> is the AFA server URL.
b. Click AlgoSec Appliance Status.
Number of Enter the number of firewalls you want to manage with AFA
Firewalls
4. Click Submit.
Your license is sent to the email address you used to log in to the AlgoSec portal.
Save it to a location accessible by the AFA server.
To activate your license, ensure that the AFA server can access the AlgoSec licensing
server, including the following:
Proxies If your browser settings use a proxy, you must also configure AFA to use
the proxy.
HTTPS Your connection must allow HTTPS traffic (TCP/443) from your AlgoSec
traffic server to www.algosec.com.
Outbound web proxies must not manipulate or sanitize traffic.
No data about the configuration of analyzed devices is passed back to AlgoSec over the
internet or to any third party.
Install a license
This procedure describes how to install a license. For details about obtaining your
license, see Obtain a license.
If you have just defined your first administrator user directly in AFA, click Install License
in the Firewall Analyzer window.
If you are in AlgoSec Firewall Analyzer, the License Information dialog appears.
For example:
From BusinessFlow
From there, click View and manage license to jump to the License Information
dialog in AlgoSec Firewall Analyzer.
2. In the AlgoSec Firewall Analyzer License Information dialog, click Install License.
4. In the License Installation dialog, click Select a File. Then, browse to and select
the license file (license.lic) you received by email. For example:
5. Click Install.
HA/DR clusters
If you are running AFA on an HA/DR cluster, apply the license to secondary appliance
as well.
Do the following:
2. Connect to the ASMS Administration interface. For details, see Connect to the
Administration Interface.
3. Enter 12.
4. When prompted, enter the path to the license file (license.lic) you received by
email.
License usage
An ASMS license is used for every on-premises or private cloud device shown at the
lowest level of the device tree.
For example, the highlighted devices in the following image each consume a single
license.
l During upgrades, any licenses consumed by VRs are not calculated towards total
consumption.
When you renew licenses, AlgoSec sales personnel will check your cloud usage and
sell you enough licenses for the number of assets actually in use.
1. In AlgoSec Firewall Analyzer, click your username at the top right, and select
License.
2. Click the links at the bottom of the dialog to download license usage
spreadsheets:
Last
Tree Parent Completed Deleted Device
Display Name Name Device IP Brand Name Report Device License ID
Breakdown
Update licenses
Contact AlgoSec to update your licenses in the following scenarios:
Expired When there are less than 45 days remaining on your license, the
licenses License link in the Administration menu turns red.
To ensure continuous use, make sure to update your license before
it expires.
Supported browsers
View ASMS in one the following web browsers, at screen resolution of 1920x1080 or
above.
l Mozilla Firefox
l Google Chrome
l Microsoft Edge
l Internet Explorer 11 and higher. Internet Explorer 8.0 is supported for FireFlow
requestors only.
Log in to ASMS
Log in to ASMS from any desktop computer using the credentials provided by an AFA
administrator.
Do the following:
If a warning message about the web server's certificate appears, click Accept or
OK. For more details, contact your network administrator.
2. In the Username and Password fields, enter your username and password, and click
Login.
For example:
Tip: If you have multiple AlgoSec products and want to change your default landing
page, see Customize your landing page.
If you are an administrator for any of these products, the relevant administration menu is
available from your user dropdown at the top-right:
l To adjust the size of the main menu, hover between the menu and the workspace
and drag the border left or right.
l To collapse the menu entirely, click at the top. When collapsed, click to
expand it again.
Do the following:
2. In the User details area > Landing page drop-down, select the landing page you
want to see when you first log in.
For example:
Do the following:
1. In the toolbar, click your username and then select About or Info.
The About dialog appears, showing details about the product you have installed.
For example:
Note: If you are running the FIPS 140-2 compliant version of AFA, this information is
indicated in the window.
Note: If Single Sign On is configured, you must browse to the Logout page hosted on
your IdP to log out.
For more details, see the AlgoSec Firewall Analyzer Administrator Guide.
Send us feedback
Let us know how we can improve your experience with the Installation and Setup Guide.
Email us at: techdocs@algosec.com
Note: For more details not included in this guide, see the online ASMS Tech Docs.