1. About this Guide

This guide has been created in order to help sales engineers, product managers, or network specialists demonstrate the PacketFence capabilities on-site with an existing or potential customer. It can also provide guidelines to setup a proof of concept for a potential PacketFence deployment using a firewall with a JSON-RPC interface.

2. Assumptions

  • You have a configured PacketFence environment with working test equipment;

  • You have a firewall with a compatible JSON-RPC interface (see below).

3. JSON-RPC interface

The JSONRPC module shipped with PacketFence is meant as a generic firewall SSO module to be used with Linux or BSD firewalls that do not by default ship with a vendor-specific interface to do SSO with.

A compatible server must implement the methods Start and Stop, both with the identical set of parameters provided below.

  • Protocol: JSON-RPC 2.0 over HTTPS

  • Authentification: HTTP Basic authentication

  • Methods: Start and Stop

  • Parameters:

    • user (string): Username that registered the device

    • mac (string): MAC address of the device

    • ip (string): IP address of the device

    • role (string): PacketFence role assigned to the device

    • timeout (int): Duration until the registration expires in seconds

  • Response: Success must be indicated by "result": ["OK"]. Every string other than OK is taken as an error message.

A simple JSON-RPC server written in Python that is compatible with this specification and creates ipsets based on the SSO information provided by PacketFence can be found at https://github.com/tribut/ipset-rpcd.

3.1. SSO Configuration in PacketFence

Go to Configuration → Integration → Firewall SSO → Add Firewall → JSONRPC.

  • Hostname or IP Address: IP of your JSON-RPC server

  • Username and Password: HTTP Basic credentials

  • Port of the service: 9090

  • Roles: Add the roles that you want to do SSO with

Configure the JSON-RPC SSO in PacketFence