Palo Alto Next Gen Firewall Integration - XML API
This document covers the API integration between the Nile Access Service and Palo Alto Networks (PAN) Next Generation Firewalls (NGFW) to provide secure campus networks through dynamic and granular segmentation. The Nile Service Block (NSB) inside the Nile Access Service communicates with PAN‑OS® through XML API calls to provide the NGFW with mappings of client IP addresses to their dot1x user identity and group. The dynamic exchanges enable organizations to apply granular segmentation policies based on the organization security strategies.
- Nile Access Service
- PAN NGFW with PAN‑OS® version 9.1 and higher
- HTTPS (TCP port 443) connection to PAN firewall for API communication
- RADIUS server
Note: The tests conducted in this guide used PAN-OS® 10.2.3-h4 and ClearPass. Although Clearpass is shown in this guide, any RADIUS server will work.
- A dot1x user authenticates to a Nile Enterprise SSID.
- The associated RADIUS server returns a ‘Filter-Id’ VSA holding the user group with the ‘Access-Accept’
- The NSB maps the username, acquired client DHCP IP address and the user group and sends via XML API to the PAN NGFW.
- The PAN firewall identifies the group as a configured tag with an associated dynamic group with a security policy that implements the desired access control on the user traffic.
- Setting up RADIUS to return ‘Filter-Id’ VSA
- Setting up PAN NGFW to identify information sent from NSB
- Setting up the Nile Access Service to communicate with PAN NGFW
- Validate the integration
The screenshots below provide examples of the Enforcement Policy and associated Profiles necessary to display the ‘Filter-ID’ attribute returned by ClearPass. It is based on the Active Directory ‘memberOf’ attribute:
The screenshots below provide examples of the Enforcement Policy and associated Profiles necessary to display the ‘Filter-ID’ attribute returned by ClearPass. It is based on the Active Directory ‘memberOf’ attribute: Enforcement Policy
This guide shows ClearPass being used as a server, but any RADIUS server can be used. The Nile Dot1x Clearpass Integration document should be reviewed for the complete ClearPass Policy Manager setup.
To create an administrator account, there are 2 steps that must be followed:
- Create an Admin Role Profile. The screenshot below shows an example of profile named ‘nile-xml-role’
- Add an administrator account and attach the Admin Role Profile created in step a. The screenshot below shows an example of the account created named ‘ nile-admin’ attaching to the Admin Role Profile named ‘nile-xml-role’
- Navigate to Device > Admin Roles, and click on the Add button
- Enter the name “nile-xml-role”
- Under the Web UI tab, disable all options.
- Under the XML API tab, disble all options except User-ID Agent
- Click on OK to complete the role addition
- Navigate to Device > Administrators, and click on the Add button
- Name: Enter the name “nile-admin”
- Password: Enter a password and confirm it
- Administrator Type: Role Based
- Profile: Select the “nile- xml-role” profile
- Click on OK to complete new account creation.
Tags are identifiers that can be used to create Dynamic Address Groups. PAN‑OS® utilizes those groups to form tag-based security policies.
For the API integration to work, Tags and Dynamic Address Groups are required. .The Staff and Student Group seen below illustrate how to create Tags. The Tags will be mapped with the user group information sent by the NSB. Subsequently, those two tags are used to configure two PAN-OS® dynamic Address Groups: Staff-role and Student-role.
- Navigate to Objects > Tags, and click on the Add button
- Add two Tags named Staff and Student
- Navigate to Objects > Address Groups, and click on the Add button
- Add two Address Groups Staff-role and Student-role of type Dynamic matching respectively the Staff and Student
This guide assumes that the Nile NSB is connected to the Palo Alto Networks firewall through two ports that are both assigned to a newly created security zone called NSB.
To illustrate an example usage of security policies based on the Dynamic Address Groups created in the previous section, two security policies are created to allow all traffic matching the ‘Staff’ Tag, and deny access to the ‘wargaming.net’ and ‘traceroute’ for traffic matching the ‘Student’ Tag:
Since the NSB connects to the PAN firewall through two Equal Cost Multi-Path (ECMP) interfaces, it is recommended to configure a loopback IP address that the NSB can use to connect to the firewall, no matter which interface the XML API traffic flows through.
For illustration purposes, the following loopback setting is shown below:
The following screenshots shows an example on how to accomplish that on the Nile Portal:
DHCP - Set the DHCP Server and Subnets for the user groups.
Authentication - Set RADIUS server parameters.
Segments – Map the DHCP server and authentication method to the user segment
Wireless – Set up the SSID and attach user segment(s)
Now Validate the integration. The validation steps below show what to look for when validating asuccessful dot1x authentication, returning the correct user group/tag through the ‘Filter-id’ attribute from ClearPass Policy Manager.
Validate that the RADIUS server has assigned the appropriate role with the correct “FilterId’. The example below demonstrates ClearPass assigned the correct role to ‘staff1’ through the returned attribute ‘Filter-Id’ with the value ‘staff1’:
A second validation for the user ‘staff1’ is shown below:
Validate that the RADIUS server has assigned the appropriate role with the correct “FilterId’. The example below demonstrates ClearPass assigned the correct role to ‘student1’ through the returned attribute ‘Filter-Id’ with the value ‘Student’:
A second validation for the user ‘student1’ is shown below:
Inside the PAN management dashboard, validate that there is correct mapping between IP and User-ID. The image below demonstrates the correct mapping between the users ‘student1’ and ‘staff1’ to their respective IP addresses 172.16.14.14 and 172.16.14.15:
Inside the PAN management dashboard, validate that there is correct mapping between IP addresses and tags. The image below demonstrates the correct mapping betweenIP addresses to their respective tags:
Inside the PAN management dashboard, validate that traffic logs are available with the right flow. The image below demonstrates that security policies created did enforce as intended. The traffic log shows that ‘wargaming.net’ and ‘traceroute’ were denied for the user ‘student1’ with IP address 172.16.14.14, when it was allowed for user ‘staff1’ with IP address 172.16.14.15:
NOTE
It is recommended to create a dedicated administrator account inside the management console with the purpose of handling XML API communication initiated by ClearPass. Note: Nile recommends contacting a Nile Operator to assist for backend setup. Before contacting a Nile Operator, make sure to create an enterprise (dot1x) SSID.
Nile recommends contacting a Nile Operator to assist for backend setup. Before contacting a Nile Operator, make sure to create an enterprise (dot1x) SSID.