Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 3.96 KB

README.md

File metadata and controls

77 lines (56 loc) · 3.96 KB
Raw

DShield PFSense Client

Convert pfSense firewall logs into DShield format for ingesting them into the DShield project.

This script should work in pfSense 2.2 and 2.3 but only has been tested currently with the most recent pfSense 2.7.0 Community Edition (CE) Release Candidate (RC), pfSense Plus 23.01-RELEASE releases as well as pfSense CE 2.6.0. It does NEED email configured on the pfSense notification setup. To adjust it, see System->Advanced->Notifications and the e-mail section.

Get the log converter script

Place this PHP script in a convenient location ie: /root/bin/dshieldpfsense.php

  1. You can copy & paste the contents of the PHP script if you have an SSH session on your pfSense box.
  2. Another approach would be to scp the file to the server. If you want to use scp, remember that you must scp as root and not admin. The admin account does not have privileges to put files on the system.
  3. You can curl the script onto the pfSense box.
  • curl https://raw.githubusercontent.com/jullrich/dshieldpfsense/master/dshield.php > /root/bin/dshieldpfsense.php

Editing necessary variables

Before running it, create the configuration file dshield.ini in the same location as the PHP script. Use dshield.sample as a template and customize settings as you wish. At a minimum, you will need to use the email address and the API key for your DShield account. You can find the API key here: https://www.dshield.org/myaccount.html

$authkey='--- insert authkey here. see dhsield.org/myaccount.html ---';
$fromaddr='--- your from address. this is where bounces will go ---';
$uid='--- your numeric userid see dshield.org/myaccount.html ---';

Common interface issue

Ensure the variable for $interfaces=array('WAN'); is set properly! You need to know the alias name of your WAN interface. This can viewed at https://<pfSense.ip>/status_interfaces.php

Excluding IP addresses and/or ports from reports

If you wish, you can exclude certain source / target IP addresses (IPv4 only for now) and/or ports from being reported. To do that, uncomment one or more of the lines below :

#source_exclude=/root/etc/dshield-source-exclude.lst
#source_port_exclude=/root/etc/dshield-source-port-exclude.lst
#target_exclude=/root/etc/dshield-target-exclude.lst
#target_port_exclude=/root/etc/dshield-target-port-exclude.lst

and edit the relevant file so it contains the exclusions you want. Lines starting with a # are regarded as comments and ignored; otherwise, each should specify either a single address (port) or a range of addresses (ports). Additionally, IP addresses should be specified using either CIDR notation (eg, 10.1.0.0/16), a range (eg, 10.1.0.0 - 10.1.255.255), or a single address (eg, 10.1.2.3).

Ensure the script is executable

chmod 770 /root/bin/dshieldpfsense.php/

Place script in crontab

11,41 * * * * /root/bin/dshieldpfsense.php

Debugging

You will see messages left by the script in the system.log. To review, use:

cat /var/log/system.log | grep dshield

or, if running on a version before 2.5.0:

clog /var/log/system.log | grep dshield

You can also change the "toaddr" in the script to temporarily send logs to a different address.

The last log sent can also be found in /tmp/lastdshieldlog

Each time the script runs, it will update /var/run/dshieldlastts with the timestamp of the last log line processed.

Please report errors or request enhancements via a bug report here.

If you require a further detailed write-up on how to use the DShield pfSense client, please refer to the write-ups here or here.