NAME
Net::Firewall::BlockerHelper::backends::pfsense - pfSense firewall alias backend for Net::Firewall::BlockerHelper.
VERSION
Version 0.1.0
SYNOPSIS
use Net::Firewall::BlockerHelper;
my $fw_helper = Net::Firewall::BlockerHelper->new(
backend => 'pfsense',
name => 'ssh',
options => {
host => 'fw.example.org',
key => 'someAPIkey',
},
);
$fw_helper->init_backend;
$fw_helper->ban(ban => '1.2.3.4');
$fw_helper->unban(ban => '1.2.3.4');DESCRIPTION
This backend blocks IPs by managing the membership of a pfSense firewall alias via the pfSense REST API package (jaredhendrickson13's pfSense-API), using its v2 endpoints and LWP::UserAgent.
A single host type alias holds all of the banned IPs. Both IPv4 and IPv6 addresses are added to the same alias, as a pfSense host alias holds an array of IP address strings regardless of family.
The alias membership is rendered from state: the full set of banned IPs is sent on every change, followed by a firewall apply so pfSense reloads the running configuration.
The alias must already exist in pfSense and be referenced by a firewall rule that does the actual blocking. This backend only manages the contents of the alias, not the alias itself nor the rule referencing it.
Auth is via the X-API-Key header, set from the key option.
LWP::UserAgent is only loaded at run time, so it is only required if this backend is actually used. For https, LWP::Protocol::https must be present as well.
NOTES
This backend was written going off the API docs and actual testing is needed to double check a few things as the exact behavior is not clear.
ban_cidr sends the alias update with the type still set to host and it is not clear whether the API will accept CIDR entries in a host type alias or if a network type alias is required, in which case the type used will need changing.
METHODS
new
Initiates the the object.
- options :: Backend specific options. See below.
- Default :: {}
- prefix :: Prefix to use. Must match the regex /^[a-zA-Z0-9]+$/
- default :: kur
- name :: Name of this specific instance. This must be specified.
- default :: undefPorts and protocols are not supported by this backend and specifying either is an error.
The options hash accepts the following.
- host :: pfSense hostname or IP the API is reached at. May include a
port, eg 'fw.example.org:8443'. This must be specified.
- Default :: undef
- key :: The pfSense REST API key, sent via the X-API-Key header. This
must be specified.
- Default :: undef
- alias :: The name of the alias the IPs are added to. The alias must
already exist in pfSense.
- Default :: <prefix>_<name>
- timeout :: HTTP timeout in seconds.
- Default :: 30
- insecure :: If true, certificate verification is disabled so
self-signed certs are accepted.
- Default :: 0All errors are considered fatal, meaning if new fails it will die.
init
Initiates the backend. Verifies the alias exists by fetching it.
No arguments are taken.
May called a second time, it will error.
$backend->init;ban
Bans an IP. The value of ban is validated as being a IPv4 or IPv6 address and lowercased, then the full alias membership including it is rendered and sent via a PATCH to /api/v2/firewall/alias, followed by a POST to /api/v2/firewall/apply. If the API calls fail, the IP is removed from the internal ban list again. Banning an already banned IP is a noop.
$backend->ban(ban => $ip);unban
Unbans an IP. The value of ban is validated as being a IPv4 or IPv6 address and lowercased, then the alias membership is re-rendered without it and sent via a PATCH to /api/v2/firewall/alias, followed by a POST to /api/v2/firewall/apply. If the API calls fail, the IP is restored to the internal ban list. Unbanning an IP that is not banned is a noop.
$backend->unban(ban => $ip);ban_cidr
Bans a CIDR range by adding it to the alias membership and applying the change via the same PATCH and apply calls used by "ban". A pfSense host alias holds CIDR ranges in the same manner as single addresses. The value of ban is validated as being a IPv4 or IPv6 CIDR range and lowercased. Banning an already banned range is a noop.
$backend->ban_cidr(ban => '1.2.3.0/24');unban_cidr
Unbans a CIDR range by removing it from the alias membership and applying the change. The value of ban is validated as being a IPv4 or IPv6 CIDR range and lowercased. Unbanning a range that is not banned is a noop.
$backend->unban_cidr(ban => '1.2.3.0/24');list_cidr
List banned CIDR ranges. Returns an array of the currently banned CIDR ranges. Single IPs are not included; for those see "list".
my @banned_cidrs = $backend->list_cidr;list
List banned IPs. Returns an array of the currently banned single IPs. CIDR ranges are not included; for those see "list_cidr".
my @banned = $backend->list;re_init
Tells the backend to re-init it's self.
This will call teardown and init again. After that it will re-add all previously added bans by rendering the full alias membership and applying.
$backend->re_init;teardown
Tears down the setup for the backend by rendering the alias with an empty membership and applying. The internal list of bans is kept, so a following re_init will re-add them. The alias itself and the rule referencing it are left in place.
$backend->teardown;stop
Alias for "teardown", provided for parity with the fail2ban actionstop concept.
$backend->stop;check
Verifies the alias is still reachable by fetching it. Returns a true value if so and a false value otherwise. This is the equivalent of fail2ban's actioncheck.
if ( !$backend->check ) {
$backend->re_init;
}flush
Removes all currently banned IPs at once by rendering the alias with an empty membership, applying, and forgetting them. The alias and the rule referencing it are left in place. This is the equivalent of fail2ban's actionflush.
$backend->flush;ERROR CODES / FLAGS
Error handling is provided by Error::Helper. All errors are considered fatal.
1, notInited
The backend has not been inited yet.
6, invalidPrefixSpecified
The specified prefix did not match /^[a-zA-Z0-9]+$/.
7, invalidName
The name is either undef or does not match /^[a-zA-Z0-9\-]+$/.
8, optionsNotHash
The item passed to new for options is not a hash.
9, noBanItem
No IP or CIDR range specified to ban or unban.
10, banItemNotIP
The item to ban is not an IP. Either wrong ref type or regexp test using Regexp::IPv4 and Regexp::IPv6 failed.
12, backendInitError
Failed to init the backend.
13, banFailed
Failed to ban the item.
14, unbanFailed
Failed to unban the item.
15, listFailed
Failed to get a list of bans.
16, reInitFailed
Failed to re_init the backend.
17, teardownFailed
Failed to teardown the backend.
18, alreadyInited
init called, but the backend has already been inited.
23, initFailed
init failed. Probing the alias failed.
24, checkFailed
The backend check raised an error.
25, flushFailed
Failed to flush the bans.
26, portsNotSupported
Ports were specified, but the backend does not support ports.
27, protocolsNotSupported
Protocols were specified, but the backend does not support protocols.
30, hostNotDefined
The option host is undef or blank.
31, keyNotDefined
The option key is undef or blank.
32, banCidrFailed
Failed to ban the CIDR range.
33, unbanCidrFailed
Failed to unban the CIDR range.
34, cidrItemNotCidr
The item to ban is not a CIDR range. Either wrong ref type or it is not an IPv4 or IPv6 address followed by a prefix length valid for its family.
35, cidrNotSupported
The backend does not support CIDR bans.
36, listCidrFailed
Failed to get a list of CIDR bans.
AUTHOR
Zane C. Bowers-Hadley, <vvelox at vvelox.ent>
BUGS
Please report any bugs or feature requests to bug-net-firewall-blockerhelper at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Firewall-BlockerHelper.
LICENSE AND COPYRIGHT
This software is Copyright (c) 2023 by Zane C. Bowers-Hadley.
This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999