Palo Alto Networks module
editPalo Alto Networks module
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
This is a module for Palo Alto Networks PAN-OS firewall monitoring logs received over Syslog or read from a file. It currently supports messages of Traffic and Threat types.
Compatibility
editThis module has been tested with logs generated by devices running PAN-OS versions 7.1 to 9.0 but limited compatibility is expected for earlier versions.
The ingest-geoip Elasticsearch plugin is required to run this module.
Set up and run the module
editBefore doing these steps, verify that Elasticsearch and Kibana are running and that Elasticsearch is ready to receive data from Filebeat.
If you’re running our hosted Elasticsearch Service on Elastic Cloud, or you’ve enabled security in Elasticsearch and Kibana, you need to specify additional connection information before setting up and running the module. See Quick start: modules for common log formats for the complete setup.
To set up and run the module:
-
Enable the module:
deb and rpm:
filebeat modules enable panw
mac:
./filebeat modules enable panw
brew:
filebeat modules enable panw
linux:
./filebeat modules enable panw
win:
PS > .\filebeat.exe modules enable panw
This command enables the module config defined in the
modules.d
directory. See Specify which modules to run for other ways to enable modules.To see a list of enabled and disabled modules, run:
deb and rpm:
filebeat modules list
mac:
./filebeat modules list
brew:
filebeat modules list
linux:
./filebeat modules list
win:
PS > .\filebeat.exe modules list
-
Set up the initial environment:
deb and rpm:
filebeat setup -e
mac:
./filebeat setup -e
linux:
./filebeat setup -e
brew:
filebeat setup -e
win:
PS > .\filebeat.exe setup -e
The
setup
command loads the recommended index template for writing to Elasticsearch and deploys the sample dashboards (if available) for visualizing the data in Kibana. This is a one-time setup step.The
-e
flag is optional and sends output to standard error instead of syslog.The ingest pipelines used to parse log lines are set up automatically the first time you run the module, assuming the Elasticsearch output is enabled. If you’re sending events to Logstash, or plan to use Beats central management, also see Load ingest pipelines manually.
-
Run Filebeat.
If your logs aren’t in the default location, see Configure the module, then run Filebeat after you’ve set the paths variable.
deb and rpm:
service filebeat start
mac:
./filebeat -e
brew:
filebeat -e
linux:
./filebeat -e
win:
PS > Start-Service filebeat
If the module is configured correctly, you’ll see
INFO Harvester started
messages for each file specified in the config.Depending on how you’ve installed Filebeat, you might see errors related to file ownership or permissions when you try to run Filebeat modules. See Config File Ownership and Permissions in the Beats Platform Reference for more information.
-
Explore your data in Kibana:
-
Open your browser and navigate to the Dashboard overview in Kibana:
http://localhost:5601/app/kibana#/dashboards.
Replace
localhost
with the name of the Kibana host. If you’re using an Elastic Cloud instance, log in to your cloud account, then navigate to the Kibana endpoint in your deployment. - If necessary, log in with your Kibana username and password.
-
Enter the module name in the search box, then open a dashboard and explore the visualizations for your parsed logs.
If you don’t see data in Kibana, try changing the date range to a larger range. By default, Kibana shows the last 15 minutes.
-
Open your browser and navigate to the Dashboard overview in Kibana:
http://localhost:5601/app/kibana#/dashboards.
Replace
ECS field mappings
editThese are the PAN-OS to ECS field mappings as well as those fields still not
in ECS that are added under the panw.panos
prefix:
Table 2. Traffic log mappings
PAN-OS Field | ECS Field | Non-standard field |
---|---|---|
Receive Time |
event.created |
|
Serial Number |
observer.serial_number |
|
Type |
event.category |
|
Subtype |
event.action |
|
Generated Time |
|
|
Source IP |
client.ip source.ip |
|
Destination IP |
server.ip destination.ip |
|
NAT Source IP |
panw.panos.source.nat.ip |
|
NAT Destination IP |
panw.panos.destination.nat.ip |
|
Rule Name |
panw.panos.ruleset |
|
Source User |
client.user.name source.user.name |
|
Destination User |
server.user.name destination.user.name |
|
Application |
network.application |
|
Source Zone |
panw.panos.source.zone |
|
Destination Zone |
panw.panos.destination.zone |
|
Ingress Interface |
panw.panos.source.interface |
|
Egress Interface |
panw.panos.destination.interface |
|
Session ID |
panw.panos.flow_id |
|
Source Port |
client.port source.port |
|
Destination Port |
destination.port server.port |
|
NAT Source Port |
panw.panos.source.nat.port |
|
NAT Destination Port |
panw.panos.destination.nat.port |
|
Flags |
labels |
|
Protocol |
network.transport |
|
Action |
event.outcome |
|
Bytes |
network.bytes |
|
Bytes Sent |
client.bytes destination.bytes |
|
Bytes Received |
server.bytes source.bytes |
|
Packets |
network.packets |
|
Start Time |
event.start |
|
Elapsed Time |
event.duration |
|
Category |
panw.panos.url.category |
|
Sequence Number |
panw.panos.sequence_number |
|
Packets Sent |
server.packets destination.packets |
|
Packets Received |
client.packets source.packets |
|
Device Name |
observer.hostname |
Table 3. Threat logs mappings
PAN-OS Field | ECS Field | Non-standard field |
---|---|---|
Receive Time |
event.created |
|
Serial Number |
observer.serial_number |
|
Type |
event.category |
|
Subtype |
event.action |
|
Generated Time |
|
|
Source IP |
client.ip source.ip |
|
Destination IP |
server.ip destination.ip |
|
NAT Source IP |
panw.panos.source.nat.ip |
|
NAT Destination IP |
panw.panos.destination.nat.ip |
|
Rule Name |
panw.panos.ruleset |
|
Source User |
client.user.name source.user.name |
|
Destination User |
server.user.name destination.user.name |
|
Application |
network.application |
|
Source Zone |
panw.panos.source.zone |
|
Destination Zone |
panw.panos.destination.zone |
|
Ingress Interface |
panw.panos.source.interface |
|
Egress Interface |
panw.panos.destination.interface |
|
Session ID |
panw.panos.flow_id |
|
Source Port |
client.port source.port |
|
Destination Port |
destination.port server.port |
|
NAT Source Port |
panw.panos.source.nat.port |
|
NAT Destination Port |
panw.panos.destination.nat.port |
|
Flags |
labels |
|
Protocol |
network.transport |
|
Action |
event.outcome |
|
Miscellaneous |
url.original |
panw.panos.threat.resource |
Threat ID |
panw.panos.threat.id |
|
Category |
panw.panos.url.category |
|
Severity |
log.level |
|
Direction |
network.direction |
|
Source Location |
source.geo.country_iso_code |
|
Destination Location |
destination.geo.country_iso_code |
|
PCAP_id |
panw.panos.network.pcap_id |
|
Filedigest |
panw.panos.file.hash |
|
User Agent |
user_agent.original |
|
File Type |
file.type |
|
X-Forwarded-For |
network.forwarded_ip |
|
Referer |
http.request.referer |
|
Sender |
source.user.email |
|
Subject |
panw.panos.subject |
|
Recipient |
destination.user.email |
|
Device Name |
observer.hostname |
Example dashboard
editThis module comes with two sample dashboards:
Configure the module
editYou can further refine the behavior of the panw
module by specifying
variable settings in the
modules.d/panw.yml
file, or overriding settings at the command line.
The module is by default configured to run via syslog on port 9001. However it can also be configured to read logs from a file. See the following example.
- module: panw panos: enabled: true var.paths: ["/var/log/pan-os.log"] var.input: "file"
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the panw
module uses
the defaults.
For more information, see Specify variable settings. Also see Advanced settings.
When you specify a setting at the command line, remember to prefix the
setting with the module name, for example, panw.panos.var.paths
instead of panos.var.paths
.
panos
fileset settings
editExample config:
panos: var.syslog_host: 0.0.0.0 var.syslog_port: 514
-
var.paths
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system. -
var.syslog_host
-
The interface to listen to UDP based syslog traffic. Defaults to
localhost
. Set to0.0.0.0
to bind to all available interfaces. -
var.syslog_port
-
The UDP port to listen for syslog traffic. Defaults to
9001
Ports below 1024 require Filebeat to run as root.
Timezone support
editThis module parses logs that don’t contain timezone information. For these logs,
Filebeat reads the local timezone and uses it when parsing to convert the
timestamp to UTC. The timezone to be used for parsing is included in the event
in the event.timezone
field.
To disable this conversion, the event.timezone
field can be removed with
the drop_fields
processor.
If logs are originated from systems or applications with a different timezone to
the local one, the event.timezone
field can be overwritten with the original
timezone using the add_fields
processor.
See Filter and enhance the exported data for information about specifying processors in your config.
Fields
editFor a description of each field in the module, see the exported fields section.