Netgate PFSense (Preview)

The Netgate PFSense package allows you to correlate endpoint network data to spot anomalous user behaviour.

The parser normalizes data to a common schema based on an OpenTelemetry standard. This schema allows you to search the data without knowing the data specifically, and just knowing the common schema instead. It also allows you to combine the data more easily with other data sources which conform to the same schema.

Preview Status

Note that this package is considered a PREVIEW. This means we are seeking feedback on the package, and may make breaking changes to the parser in the future. It means also it may not include all documentation which usually we publish for packages.

Given the preview status of this package there are some limitations to what the parser is able to do. Please check out the package on Marketplace to see the most recent list of limitations.

Installing the Package in LogScale

Find the repository where you want to send the Netgate PFSense (Preview) events, or Creating a Repository or View.

  1. Navigate to your repository in the LogScale interface, click Settings and then Packages on the left.

  2. Click Marketplace and install the LogScale package for Netgate PFSense (Preview) (i.e. netgate/pfsense).

  3. When the package has finished installing, click Ingest tokens on the left still under the Settings.

  4. In the right panel, click + Add Token to create a new token. Give the token an appropriate name (e.g. the name of the event hub it will collect logs from), and leave the parser unassigned, you can assign the parser pfsense-syslog to the LogScale Collector Configuration as described in the documentation Sources & Examples.

    Before leaving this page, view the ingest token and copy it to your clipboard — to save it temporarily elsewhere.

    Now that you have a repository set up in LogScale along with an ingest token you're ready to send logs to LogScale.

Configurations and Sending the Logs to LogScale

  1. You also need to setup Remote Logging Options under Status/System Logs/settings in PFSense. and select Firewall Event under Remote Syslog Contents. Forward the logs to Falcon LogScale Collector

  2. Next, configure the Falcon LogScale Collector to ship the logs from your syslog server into LogScale. Follow LogScale Collector Installing the LogScale Collector and Configuring LogScale Collector. LogScale Collector documentation also provides an example of how you can configure your syslog datasource, see Sources & Examples.

Make sure to select BSD (RFC 3164, default) as the Log Format. For more information on how to set up logging in PFSense please refer to PFSense Manual.

Verify Data is Arriving in LogScale

Once you have completed the above steps the Netgate PFSense (Preview) data should be arriving in your LogScale repository.

You can verify this by doing a simple search for the events:

logscale
#Vendor = "netgate" 
| Product="pfsense"

Package Contents Explained

This package parses incoming data, and normalizing the data as part of that parsing. The parser normalizes the data to a subset of this schema based on OpenTelemetry standards, while still preserving the original data.

If you want to search using the original field names and values, you can access those in the fields whose names are prefixed with the word Vendor. Fields which are not prefixed with Vendor are standard fields which are either based on the schema (e.g. source.ip) or on LogScale conventions (e.g. @rawstring).

The fields which the parser currently maps the data to, are chosen based on what seems the most relevant, and will potentially be expanded in the future. But the parser won't necessarily normalize every field that has potential to be normalized.

Event Categorisation

As part of the schema, events are categorized by fields:

  • event.outcome

  • event.category

event.category is an array so needs to be searched using the following syntax:

array:contains("event.category[]", value="network")

For example, the following will find events where some event.type[n] field contains the value network, regardless of what n is.

Note that not all events will be categorized to this level of detail.

Normalized Fields

Here are some of the normalized fields which are being set by this parser:

  • event.* (e.g. event.action, event.reason )

  • network.* (e.g. network.transport )

  • rule.* (e.g. rule.id )

  • destination.* (e.g. destinatio.ip, destination.port )

  • source.* (e.g. source.ip, source.port )

  • related.* (e.g, related.ip )