Palo Alto Networks PAN-OS integration (TSCM CLI)

Overview

This document describes how to integrate ThreatSTOP’s Policy and Reporting services with a Palo Alto Networks PAN-OS device:

• Configuration of Dynamic Block Lists, Policy configuration and Log forwarding using the PAN-OS API
• Automated retrieval and updates of IP Defense policies from ThreatSTOP’s systems to the PAN-OS device.
• Automated collection and upload of log files from the PAN-OS Device to ThreatSTOP’s systems.

Integration types

ThreatSTOP Policies can be integrated with PAN-OS devices with different methods:

• HTTP integration: no appliance VM is required (documentation)
• TSCM CLI integration: requires an appliance VM, configured via CLI (this document)
• TSCM with Web Automation integration: requires an appliance VM, configured via the ThreatSTOP Portal (documentation)

The HTTP integration and TSCM integrations (CLI and Web Automation) differs as follows:

System view

The integration is performed by a Linux-based virtual machine provided by ThreatSTOP, named ThreatSTOP Centralized Manager (TSCM). After its initial installation, the TSCM will retrieve the list of subnets matching the policy configured via the ThreatSTOP Admin portal and update the PAN-OS firewall using the PAN-OS XML API. Optionally, the firewall can be configured to send the connection log events to the TSCM via syslog and the TSCM will package and upload log files to ThreatSTOP’s Portal, for analysis and reporting.

Fig 1. : Network traffic between ThreatSTOP services, the TSCM and the PAN-OS Firewall. (click to expand)

Shell configuration

This document provides the steps using the Command Line-based installation of ThreatSTOP. Using the Command Line method, device settings are configured on the command line. The initial configuration and future changes must be done using the TSCM CLI. Changes to the policy assignment must be done on both the portal and TSCM CLI.

For the Web-based installation, please read this document instead.

Compatibility

• Virtual Systems (VSYS) are supported

• The Maximum Policy Size is the maximum number of ACLs that your device can support. It depends on the hardware and memory available on the device. It can be retrieved from the device using the CLI:

  admin@PA-500> show system state | match cfg.general.max-address
  

  • The Maximum Policy Size is the number of address groups (cfg.general.max-address-group) multiplied by the number of addresses in a single address group (cfg.general.max-address-per-group).
  • PAN Article on the topic.

Current version of TSCM

The current version of the TSCM OVA is 1.50. If your TSCM image is older, please download the latest version from the device configuration page in the Admin Portal. You can find out the TSCM version by running

$ tsadmin version

The current version of the PAN-OS module is 1.20-01 (included with TSCM 1.50)

Installation parameters for experienced users

If you have already created a device entry in the portal, and are familiar with the installation procedure, you can access the TSCM parameters below if you access this document from the Portal Device page.

Prerequisites

System

The TSCM is delivered as an OVA or VHD image, built using Ubuntu 20.04 as the base Operating System. It is preconfigured with:

• 2 CPUs
• 2 GB of RAM
• 20 GB of disk space

You will need a Hypervisor such as vSphere, ESXi, Virtualbox or Hyper-V to deploy the image.

Connectivity

To retrieve its configuration and policy, and to upload log data, the TSCM needs the following connectivity:

• DNS over TCP - Policy service
  • Hostname: ts-dns.threatstop.com
  • IP Range: 192.124.129.0/24
  • Outbound TCP port 53 or 5353
• HTTPS - Log service
  • Hostname: logs.threatstop.com
  • IP range: 204.68.99.208/28
  • Outbound TCP port 443
  • Direct Connection or via Proxy
• NTP
  • Hostname: ntp.ubuntu.com
  • Outbound UDP port 123

It must also be able to communicate with the PAN-OS device:

• HTTP
  • TCP Port 80
  • From the PAN-OS device to the TSCM (ACL updates)
• HTTPs
  • TCP Port 443
  • From the TSCM to the PAN-OS firewall (Configuration)
• Syslog
  • TCP or UDP Port 514
  • From the PAN-OS firewall to the TSCM (Log forwarding)

PAN-OS credentials

To perform this installation, you need an account with API access on the PAN-OS firewall.

Setup

Integration ThreatSTOP with a PAN-OS device using the TSCM CLI is performed in 4 steps:

1. Configuring the device settings on the Admin Portal
2. Downloading and loading the VM image
3. Configure the device settings using the TSCM CLI
4. Apply ACLs and configure log forwarding on the firewall

Step 1: Portal

During this step, you will create a device entry on the Admin Portal. You will select a device type (PAN-OS PA Series) and enter the configuration settings. A minimum configuration only requires a handful of settings but optional, advanced options are also available.

To create a PAN-OS device entry:

• Log into the Admin Portal with your ThreatSTOP account
• Browse to the Device page and click Add Device
• Select the PAN-OS model:
  • Type: IP Defense
  • Manufacturer: Palo Alto Networks
  • Model: PA Series
  • Integration Type: TSCM

The Admin Portal will display a form to enter the device settings described below and the links to retrieve the TSCM image.

• Nickname: this is a mnemonic name used to identify the device. It can be set to any string (A-Z, 0-9, - and _). If you create multiple device entries, each entry must have a unique nickname. The Nickname will be used to identify the device on the TSCM and in the Reporting user interface.

• Policy: select a pre-defined policy or a customized policy. It must be an IP Defense Policy.

• IP Type: Access to the ThreatSTOP services is controlled in part using an ACL allowing the device IP to connect. If your device has a static public IP address (the most common case), select static. If your device has a dynamic public IP address, the ThreatSTOP services can lookup the IP address using a DNS fully-qualified name (FQDN).

• Public IP address: In static mode, this is the public IP address of the device. It is possible to configure multiple device entries with the same public IP address.

• Domain name: In Dynamic mode, this is a DNS FQDN which must be kept up-to-date as an A record pointing to the device’s dynamic IP.

• Note: An optional field to store a note of your choice about the device - location, identifiers, model…

Upon saving the form, a device entry will be created in ThreatSTOP’s cloud.

Step 2: Download and boot image

After creating the device entry, the next step is the download using FTP and installation of the TSCM image.

You can choose between the OVA format (ESXi/vSphere, VirtualBox, Xen…) and the VHD format (Microsoft Hyper-V).

The download link is listed in the Step 2 section, as shown in this image.

• Click on the Copy Download Link to copy the link to your clipboard
• Use an ftp client of your choice, or a tool such as curl
• For your security: after downloading the file, we encourage you to validate its SHA 256 checksum. Compute it as shown below and compare it to the checksum in the Portal.

  $ shasum -a 256 <filename>
  

• Import the OVA or VHD file in your Hypervisor to create the virtual machine and start it.

Log into the TSCM

The TSCM virtual machine will use DHCP to obtain its IP address. If your Hypervisor doesn’t show the IP address assigned to the virtual machine, you can retrieve it from the console of the TSCM: it is displayed as part of the login prompt.

The virtual machine will be reachable using ssh:

• The default username is: threatstop
• The default password is: threatstop

Step 3: Configure the Device settings using the TSCM CLI

After booting the TSCM and logging in via ssh, the third setup step will link the virtual machine to the device entry created in Step 1.

The TSCM has a configuration utility named tsadmin. A reference for the utility is provided here but we will cover the full installation steps below.

• Obtain the Device ID and Policy zone names from the device configuration or device info pages on the portal

• Login with the threatstop account using ssh

• Run the following command:

$ tsadmin add --type pan [device nickname]

• The tsadmin command will prompt you for the following device settings.

  • Device ID (tdid): A unique identifier for the device. This setting must be correct for the TSCM to operate normally. This setting can be retrieved from the Device settings or Device Info page on the portal.

  • Device Management IP address: This is the internal address of the device. The TSCM will communicate with the PAN device via HTTP using this IP address.

  • Block list name: the name of the zone associated with the Block list of the policy selected in the portal. This setting can be retrieved from the Device settings or Device Info page on the portal.

  • Allow list name: the name of the zone associated with the Allow list of the policy selected in the portal. This setting can be retrieved from the Device settings or Device Info page on the portal.

  • Syslog Profile: enter the name of a syslog profile to create a new profile for the TSCM. Use ‘none’ to avoid creating a new syslog profile.

  • Trusted Zone: the list of networks for your internal (trusted) networks. If your PAN-OS configuration includes several zones, provide them as a comma-separated list. The default setting is Trusted.

  • Untrusted Zone: the list of networks for your internal (trusted) networks. If your PAN-OS configuration includes several zones, provide them as a comma-separated list. The default setting is Untrusted.

  • Virtual System Name: enter the name of the virtual system (vsys) as it appears at the top of the screen when viewing your vsys. This is not the entry in the Name field of the device, but has the format vsysX (where X is a number) and should appear at the top of the screen when configuring the PAN-OS device. For a single firewall instance, this would be vsys1.

  • Block Action: This option allows you to define what action will be taken (drop, or deny) for matching block entries.

  • Number of Dynamic Lists: the number of dynamic lists ThreatSTOP may use to distribute block / allow entries into. We use one list for allow and the remaining lists for block entries. You can adjust this setting to meet the available resources on your device. The following article states PAN-OS version 7.1+ has ability to create up to 30 dynamic lists. If you have a version older than this please assume you only have up to 9 dynamic lists. We use one list for allow and the remaining lists for block entries. If you have custom dynamic lists already generated, you will need to drop this number to account for the number of block and allow lists you currently have setup.

  Note: The number of addresses in a dynamic block list is determined by the maximum number of IP addresses your firewall hardware supports. …The PA-5200 Series and the PA-7000 Series firewalls support a maximum of 150,000 total IP addresses; all other models support a maximum of 50,000 total IP addresses… ^{‡ Ref.} To support PAN devices older than 7.0.x we automatically calculate the maximum number of IPs per dynamic list by fetching the show system state | match cfg.general.max-address output and using the max-address value minus 300 (reserved by PAN on older systems). If you are running a device that supports 50,000 IPs on PAN-OS >= 7.1, it doesn’t make sense to select more than 11 block lists (11 * 4700 = 51,700, which would fill up to 50,000 then stop and warn it couldn’t finish loading the rest of the addresses). To view the number of addresses supported by your device, see this article

  • Send logs to ThreatSTOP?: If enabled, the TSCM will send logs received from the device to the ThreatSTOP reporting system. This is the recommended setting. When disabled, logs for this device will not be available for reporting in the Portal.

  • Device username: the username for a PAN-OS account available with API access

  • Device password: the password for the PAN-OS account

Advanced Settings

The TSCM supports the following advanced settings, which cover uncommon PAN-OS configurations or network environments. To enable the advanced settings, add the –advanced option to the tsadmin command line

$ tsadmin add --type pan --advanced [device nickname]

Enable policy updates? (y or n) [default y] Enable syslog forward? (y or n) [default n] Is this device part of an HA/cluster setup? If so, enter the additional IP(s) (space-separated), or “none” for no HA : [default none] User name prompt : (leave empty unless you have customized the device’s user name prompt) [default empty] Password prompt : (leave empty unless you have customized the device’s password prompt) [default empty]

• DNS Port: The TSCM uses TCP Port 53 (outbound connections) to retrieve policy data. If this port is blocked or filtered (for example, networks using a DNS Application Layer Gateway), use this setting to switch to TCP Port 5353.

• Additional syslog source IP(s): Typically, logs will sent over syslog by the device itself. If logs are sent by another IP address (for example, after being processed by a SIEM, or in High-Availability configurations), that IP address should be configured in this field.

• Log rotate size: the TSCM will upload logs after 15 minutes and when the log file size is reached. For systems under very heavy network traffic with many blocked connections, lowering this value will cause logs to be uploaded more often.

• Enable policy updates: this setting can be used to temporarily disabled policy updates by the TSCM. This is not recommended but can be used if device configuration changes needed to be suspended.

• Syslog Forward: if you want the TSCM to forward the logs to another systems (in addition to uploading them to ThreatSTOP’s cloud for reporting), enter yes. The CLI will prompt for the IP address, Port and protocol (UDP or TCP) that logs should be forwarded to.

• Log Upload Proxy: If your environment requires using a proxy to reach HTTPs URLs, you can specify the address of a proxy. The proxy must support HTTPs using the CONNECT protocol. The proxy address must be http://address:port, where address is either an IP address or a fully-qualified domain name. HTTPs proxies are not supported. If you provide a proxy URL, the TSCM configuration will also prompt you for an optional user and password. Provide them if the proxy requires authentication.

• HA Cluster IP addresses: See the High-Availability section below

At this time, the TSCM has succesfully configured the device entry.

You can view the list of devices linked on the TSCM image:

$ tsadmin list
| Device name | Type       | Device ID     | Management IP | Log upload ID | Log  | Log uploads |
| tstest      | pan        | tdid_abcd1234 | 172.21.50.3   | tdid_abcd1234 | 100k | enabled     |

• From this point on, the TSCM will retrieve policy data (IP subnets) and configure them on the PAN devices, every hour.
• To force the initial update and proceed with testing, run the following command

  $ tsadmin update <device name>
  

This will configure the PAN with the settings provided above, set the syslog source IP, establish the syslog server, setup log forwarding, create the EBLs and then setup the policies.

Configuration of the TSCM is now complete, but the policies uploaded to the TSCM will not be active at this point. You will need to login to the firewall and activate the policies.

Step 4: PAN-OS Configuration

The PAN-OS firewall will retrieve policy data from the TSCM over HTTP. To apploy the policies in the PAN-OS device, follow these steps:

ACL Configuration

• Log into your PAN device through the web management interface.
• Click on Policies.
• You will see all of your rules established for your policy on this device, including four rules for ThreatSTOP:
  • ThreatSTOP-Allow-Inbound
  • ThreatSTOP-Allow-Outbound
  • ThreatSTOP-Block-Inbound
  • ThreatSTOP-Block-Outbound
• Place these rules where you want them in your policy. We recommend placing them at the top.
• After placing the rules in your desired location select all four rules, and click Enable at the bottom of the screen.
• Now click Commit at the top of the screen to enact the changes.

• To complete the installation, you can force the import of the policy data in the EBL.
  • Click Objects.
  • Click Dynamic Block Lists.
  • Check the box next to the lists you want imported immediately.
  • Click Import Now.

You can test that the policy is correctly applied by pinging bad.threatstop.com (64.87.3.133) through the device, a test IP included in all policies. The ping command should fail.

Log forwarding

You have the option of setting up log forwarding for your policies policies using syslog and Log forwarding. This will enable the reporting features for this device on the ThreatSTOP portal.

This procedure has two parts, one of ThreatSTOP and one for existing policies on the PAN.

To turn on Log Forwarding to ThreatSTOP:

• Under Objects click Log Forwarding.
• Click on the syslog profile configured during the setup (default ThreatSTOP).
• Select any of the data you want to forward and click OK.
• Click on Commit

Logging and Reporting

If log upload is enabled, the TSCM will now upload logs every 15 minutes, as long as there were connections blocked by the policy since the last upload. The logs can be analyzed in the IP Defense Reports 15 minutes after they’ve been uploaded.

To check that the log upload feature is able to reach the server:

• After applying the ACLs, generate log entries by trying to reach our test address through the device. The command should fail to connect.

  curl http://bad.threatstop.com
  

• Run the following command on the TSCM to rotate and upload the log file

  $ tsadmin logs
  

If the command doesn’t find a log file to upload, it will exit immediately:

threatstop@tsclient:~$ tsadmin logs
[INFO ] : Starting log upload client
[INFO ] : Log upload client exited

• Log files are stored in /var/log/threatstop/devices/<device name>/syslog.
• If no log file is present, check the syslog forwarding configuration on the device and check that the ACL is applied.

Successful upload:

threatstop@tsclient:~$ tsadmin logs
[INFO ] : Starting log upload client
[INFO ] : [Uploader] Loading device configuration
[INFO ] : Processing logs for device [devicename]
[INFO ] : Starting ThreatSTOP logupload operation v2.00 at 24/05/2018 19:34:05
[INFO ] : Verifying log file [/var/log/threatstop/devices/pan135/syslog.1] stats
[INFO ] : Processing [/var/log/threatstop/devices/devicename/syslog.1] log file
[INFO ] : Start sending data
[INFO ] : Preparing connection data
[INFO ] : Connecting to https://logs.threatstop.com:443/logupload.pl
[INFO ] : Upload was successful [200 OK]
[INFO ] : Completed processing for device [pan135]
[INFO ] : Finish ThreatSTOP logupload operation at 24/05/2018 19:34:10 after 00:00:05
[INFO ] : Log upload client exited

If the command attempts to upload a log but fails, check the connectivity of the TSCM to ThreatSTOP’s log service, described in the connectivity section of this document.

Additional considerations

Support for multiple devices

High-Availability clusters

If your PAN-OS firewall is part of a High-Availability pair (Active/Active or Active/Passive), the TSCM can connect to each device to maintain the configuration. The devices must have the same set of credentials.

• Configure the management IP address of the backup system in the HA cluster in the ‘HA Device IP address’ field.
• Configure the same IP address as Syslog IP to allow the TSCM to receive logs from the backup node
• Repeat the configuration steps on the backup node to apply the Dynamic Lists and forward logs to the TSCM

Other operations

Current configuration

To view the current settings on the TSCM, run

$ tsadmin show <device name>

Configuration changes

• To update the configuration of the device, run the tsadmin ‘configure’ command:

  $ tsadmin configure <device name>
  

The configure command also supports the –advanced option enable the advanced settings described in the configuration section of this document.

Software updates

To update the TIP and retrieve new versions of the ThreatSTOP software, login as threatstop and run the following command:

$ sudo apt-get update && sudo apt-get -y dist-upgrade

Uninstall steps

• On the device, disable the ThreatSTOP Policy Rules. These rules reference the dynamic block lists and the log forwarding profile. Until they are removed, you will be unable to delete the configurations under Policies->Security. Check each of the four ThreatSTOP policy rules

• Click Disable at the bottom of the policy rules window

• Log into the TSCM and run:

  $ tsadmin remove <devicename>
  

This will remove the PANOS device and all ThreatSTOP Policy Rules, as well as the dynamic block lists and log forwarding profile.

• The last step is to delete the device entry on the Portal, using the Device List page. This step will caused the log data from the device to be unavailable in the Reporting interface of the Portal. If needed, you can recreate a new device entry for the same device, with the same or different settings. Note that the new entry will have a different Device ID for linking the TSCM.

Additional information

Troubleshooting

• Failure to link the device: tsadmin add fails with this error: “Failed to connect to Web Automation services”. The common cause is a network connectivity problem using DNS over TLS (Outbound TCP connection to ts-ctp.threatstop.com on port 5353).

• Failure to link the device: tsadmin add fails with this error: “Failed to retrieve settings using Web Automation. There are three common causes:
  • The Device ID or Device Key is not correct.
  • The system time is not correct. The virtual machine run an NTP client which must be up-to-date. Check its status with the timedatectl command.
  • The new device entry has not been activated yet. Wait 2-3 minutes and retry.
• Failure to retrieve policy: tsadmin add fails with this error: “block or allow list [name] could not be fetched from ThreatSTOP DNS servers.” There are two common causes:
  • A network connectivity problem using DNS over TCP (Outbound connection to ts-dns.threatstop.com on Port 53).
  • The policy is not available yet. It typically takes less than 15 minutes for new devices and new policies to be activated in the Policy Service.

• If the network connectivity is ok, and 15 minutes have elapsed since the device entry was created, please contact ThreatSTOP Support at [email protected].

• If tsadmin add fails to connect to the device, check the credentials (username, password).

• If you are receiving “Unable to fetch external dynamic list. Timeout was reached” error messages, check if you have an EDL or Palo Alto Network Services Service Route setup. This may be overriding the update fetching interface route. See this article for more details.

Version history

• TSCM

• PAN OS Module

Related documents

• TSCM reference
• Creating custom policies
• Maximum size of Address Groups
• PAN OS API
• PAN-OS Security Zones
• Command-line based version of TSCM for PAN-OS