| 1 |
c0b6fdde
|
jim-p
|
<?php
|
| 2 |
|
|
/*
|
| 3 |
|
|
easyrule.inc.php
|
| 4 |
|
|
|
| 5 |
998f77a8
|
jim-p
|
Copyright (C) 2009-2010 Jim Pingle (jpingle@gmail.com)
|
| 6 |
|
|
Originally Sponsored By Anathematic @ pfSense Forums
|
| 7 |
c0b6fdde
|
jim-p
|
All rights reserved.
|
| 8 |
|
|
|
| 9 |
|
|
Redistribution and use in source and binary forms, with or without
|
| 10 |
|
|
modification, are permitted provided that the following conditions are met:
|
| 11 |
|
|
|
| 12 |
|
|
1. Redistributions of source code must retain the above copyright notice,
|
| 13 |
|
|
this list of conditions and the following disclaimer.
|
| 14 |
|
|
|
| 15 |
|
|
2. Redistributions in binary form must reproduce the above copyright
|
| 16 |
|
|
notice, this list of conditions and the following disclaimer in the
|
| 17 |
|
|
documentation and/or other materials provided with the distribution.
|
| 18 |
|
|
|
| 19 |
|
|
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
| 20 |
|
|
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
| 21 |
|
|
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
| 22 |
|
|
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
|
| 23 |
|
|
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
| 24 |
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
| 25 |
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
| 26 |
|
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
| 27 |
|
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
| 28 |
|
|
POSSIBILITY OF SUCH DAMAGE.
|
| 29 |
|
|
*/
|
| 30 |
7ac5a4cb
|
Scott Ullrich
|
/*
|
| 31 |
dadad8b3
|
jim-p
|
pfSense_BUILDER_BINARIES:
|
| 32 |
7ac5a4cb
|
Scott Ullrich
|
pfSense_MODULE: filter
|
| 33 |
|
|
*/
|
| 34 |
c0b6fdde
|
jim-p
|
|
| 35 |
|
|
$blockaliasname = 'EasyRuleBlockHosts';
|
| 36 |
865ff9b4
|
jim-p
|
$protocols_with_ports = array('tcp', 'udp');
|
| 37 |
|
|
require_once("functions.inc");
|
| 38 |
|
|
require_once("util.inc");
|
| 39 |
|
|
require_once("config.inc");
|
| 40 |
4d828a9a
|
Ermal Lu?i
|
|
| 41 |
c0b6fdde
|
jim-p
|
function easyrule_find_rule_interface($int) {
|
| 42 |
|
|
global $config;
|
| 43 |
|
|
/* Borrowed from firewall_rules.php */
|
| 44 |
4d828a9a
|
Ermal Lu?i
|
$iflist = get_configured_interface_with_descr(false, true);
|
| 45 |
dadad8b3
|
jim-p
|
|
| 46 |
c0b6fdde
|
jim-p
|
if ($config['pptpd']['mode'] == "server")
|
| 47 |
|
|
$iflist['pptp'] = "PPTP VPN";
|
| 48 |
dadad8b3
|
jim-p
|
|
| 49 |
bd40781a
|
Seth Mos
|
if ($config['pppoe']['mode'] == "server")
|
| 50 |
c0b6fdde
|
jim-p
|
$iflist['pppoe'] = "PPPoE VPN";
|
| 51 |
dadad8b3
|
jim-p
|
|
| 52 |
4d828a9a
|
Ermal Lu?i
|
if ($config['l2tp']['mode'] == "server")
|
| 53 |
|
|
$iflist['l2tp'] = "L2TP VPN";
|
| 54 |
|
|
|
| 55 |
c0b6fdde
|
jim-p
|
/* add ipsec interfaces */
|
| 56 |
c6dfd289
|
jim-p
|
if (isset($config['ipsec']['enable']) || isset($config['ipsec']['client']['enable'])){
|
| 57 |
c0b6fdde
|
jim-p
|
$iflist["enc0"] = "IPSEC";
|
| 58 |
|
|
}
|
| 59 |
dadad8b3
|
jim-p
|
|
| 60 |
c0b6fdde
|
jim-p
|
if (isset($iflist[$int]))
|
| 61 |
|
|
return $int;
|
| 62 |
|
|
|
| 63 |
|
|
foreach ($iflist as $if => $ifd) {
|
| 64 |
|
|
if (strtolower($int) == strtolower($ifd))
|
| 65 |
|
|
return $if;
|
| 66 |
|
|
}
|
| 67 |
dadad8b3
|
jim-p
|
|
| 68 |
066afaf1
|
jim-p
|
if (substr($int, 0, 4) == "ovpn")
|
| 69 |
|
|
return "openvpn";
|
| 70 |
|
|
|
| 71 |
c0b6fdde
|
jim-p
|
return false;
|
| 72 |
|
|
}
|
| 73 |
|
|
|
| 74 |
|
|
function easyrule_block_rule_exists($int = 'wan') {
|
| 75 |
|
|
global $blockaliasname, $config;
|
| 76 |
|
|
/* No rules, we we know it doesn't exist */
|
| 77 |
|
|
if (!is_array($config['filter']['rule'])) {
|
| 78 |
|
|
return false;
|
| 79 |
|
|
}
|
| 80 |
|
|
|
| 81 |
|
|
/* Search through the rules for one referencing our alias */
|
| 82 |
28a581b8
|
jim-p
|
foreach ($config['filter']['rule'] as $rule) {
|
| 83 |
f3704cb2
|
jim-p
|
if (!is_array($rule) || !is_array($rule['source']))
|
| 84 |
|
|
continue;
|
| 85 |
c0b6fdde
|
jim-p
|
if ($rule['source']['address'] == $blockaliasname . strtoupper($int) && ($rule['interface'] == $int))
|
| 86 |
|
|
return true;
|
| 87 |
28a581b8
|
jim-p
|
}
|
| 88 |
c0b6fdde
|
jim-p
|
return false;
|
| 89 |
|
|
}
|
| 90 |
|
|
|
| 91 |
|
|
function easyrule_block_rule_create($int = 'wan') {
|
| 92 |
|
|
global $blockaliasname, $config;
|
| 93 |
|
|
/* If the alias doesn't exist, exit.
|
| 94 |
|
|
* Can't create an empty alias, and we don't know a host */
|
| 95 |
|
|
if (easyrule_block_alias_getid($int) === false)
|
| 96 |
|
|
return false;
|
| 97 |
|
|
|
| 98 |
|
|
/* If the rule already exists, no need to do it again */
|
| 99 |
|
|
if (easyrule_block_rule_exists($int))
|
| 100 |
|
|
return true;
|
| 101 |
|
|
|
| 102 |
|
|
/* No rules, start a new array */
|
| 103 |
|
|
if (!is_array($config['filter']['rule'])) {
|
| 104 |
|
|
$config['filter']['rule'] = array();
|
| 105 |
|
|
}
|
| 106 |
|
|
|
| 107 |
|
|
filter_rules_sort();
|
| 108 |
|
|
$a_filter = &$config['filter']['rule'];
|
| 109 |
|
|
|
| 110 |
|
|
/* Make up a new rule */
|
| 111 |
|
|
$filterent = array();
|
| 112 |
|
|
$filterent['type'] = 'block';
|
| 113 |
dadad8b3
|
jim-p
|
$filterent['interface'] = $int;
|
| 114 |
c0b6fdde
|
jim-p
|
$filterent['source']['address'] = $blockaliasname . strtoupper($int);
|
| 115 |
|
|
$filterent['destination']['any'] = '';
|
| 116 |
5bd033a0
|
Renato Botelho
|
$filterent['descr'] = gettext("Easy Rule: Blocked from Firewall Log View");
|
| 117 |
c0b6fdde
|
jim-p
|
|
| 118 |
a0140246
|
jim-p
|
array_splice($a_filter, 0, 0, array($filterent));
|
| 119 |
c0b6fdde
|
jim-p
|
|
| 120 |
|
|
return true;
|
| 121 |
|
|
}
|
| 122 |
|
|
|
| 123 |
|
|
function easyrule_block_alias_getid($int = 'wan') {
|
| 124 |
|
|
global $blockaliasname, $config;
|
| 125 |
|
|
if (!is_array($config['aliases']))
|
| 126 |
|
|
return false;
|
| 127 |
|
|
|
| 128 |
|
|
/* Hunt down an alias with the name we want, return its id */
|
| 129 |
|
|
foreach ($config['aliases']['alias'] as $aliasid => $alias)
|
| 130 |
|
|
if ($alias['name'] == $blockaliasname . strtoupper($int))
|
| 131 |
|
|
return $aliasid;
|
| 132 |
|
|
|
| 133 |
|
|
return false;
|
| 134 |
|
|
}
|
| 135 |
|
|
|
| 136 |
|
|
function easyrule_block_alias_add($host, $int = 'wan') {
|
| 137 |
|
|
global $blockaliasname, $config;
|
| 138 |
|
|
/* If the host isn't a valid IP address, bail */
|
| 139 |
|
|
if (!is_ipaddr($host))
|
| 140 |
|
|
return false;
|
| 141 |
|
|
|
| 142 |
|
|
/* If there are no aliases, start an array */
|
| 143 |
|
|
if (!is_array($config['aliases']['alias']))
|
| 144 |
|
|
$config['aliases']['alias'] = array();
|
| 145 |
|
|
|
| 146 |
|
|
$a_aliases = &$config['aliases']['alias'];
|
| 147 |
|
|
|
| 148 |
|
|
/* Try to get the ID if the alias already exists */
|
| 149 |
|
|
$id = easyrule_block_alias_getid($int);
|
| 150 |
|
|
if ($id === false)
|
| 151 |
|
|
unset($id);
|
| 152 |
|
|
|
| 153 |
|
|
$alias = array();
|
| 154 |
|
|
|
| 155 |
|
|
if (isset($id) && $a_aliases[$id]) {
|
| 156 |
|
|
/* Make sure this IP isn't already in the list. */
|
| 157 |
|
|
if (in_array($host.'/32', explode(" ", $a_aliases[$id]['address'])))
|
| 158 |
|
|
return true;
|
| 159 |
|
|
/* Since the alias already exists, just add to it. */
|
| 160 |
|
|
$alias['name'] = $a_aliases[$id]['name'];
|
| 161 |
|
|
$alias['type'] = $a_aliases[$id]['type'];
|
| 162 |
|
|
$alias['descr'] = $a_aliases[$id]['descr'];
|
| 163 |
|
|
|
| 164 |
|
|
$alias['address'] = $a_aliases[$id]['address'] . ' ' . $host . '/32';
|
| 165 |
5bd033a0
|
Renato Botelho
|
$alias['detail'] = $a_aliases[$id]['detail'] . gettext('Entry added') . ' ' . date('r') . '||';
|
| 166 |
c0b6fdde
|
jim-p
|
} else {
|
| 167 |
|
|
/* Create a new alias with all the proper information */
|
| 168 |
|
|
$alias['name'] = $blockaliasname . strtoupper($int);
|
| 169 |
|
|
$alias['type'] = 'network';
|
| 170 |
9d3d8d00
|
Vinicius Coque
|
$alias['descr'] = gettext("Hosts blocked from Firewall Log view");
|
| 171 |
c0b6fdde
|
jim-p
|
|
| 172 |
|
|
$alias['address'] = $host . '/32';
|
| 173 |
5bd033a0
|
Renato Botelho
|
$alias['detail'] = gettext('Entry added') . ' ' . date('r') . '||';
|
| 174 |
c0b6fdde
|
jim-p
|
}
|
| 175 |
|
|
|
| 176 |
|
|
/* Replace the old alias if needed, otherwise tack it on the end */
|
| 177 |
|
|
if (isset($id) && $a_aliases[$id])
|
| 178 |
|
|
$a_aliases[$id] = $alias;
|
| 179 |
|
|
else
|
| 180 |
|
|
$a_aliases[] = $alias;
|
| 181 |
9bb8d542
|
Ermal Lu?i
|
|
| 182 |
|
|
// Sort list
|
| 183 |
|
|
$a_aliases = msort($a_aliases, "name");
|
| 184 |
c0b6fdde
|
jim-p
|
|
| 185 |
|
|
return true;
|
| 186 |
|
|
}
|
| 187 |
|
|
|
| 188 |
|
|
function easyrule_block_host_add($host, $int = 'wan') {
|
| 189 |
|
|
global $retval;
|
| 190 |
|
|
/* Bail if the supplied host is not a valid IP address */
|
| 191 |
|
|
if (!is_ipaddr($host))
|
| 192 |
|
|
return false;
|
| 193 |
|
|
|
| 194 |
|
|
/* Flag whether or not we need to reload the filter */
|
| 195 |
|
|
$dirty = false;
|
| 196 |
|
|
|
| 197 |
|
|
/* Attempt to add this host to the alias */
|
| 198 |
|
|
if (easyrule_block_alias_add($host, $int)) {
|
| 199 |
|
|
$dirty = true;
|
| 200 |
|
|
} else {
|
| 201 |
|
|
/* Couldn't add the alias, or adding the host failed. */
|
| 202 |
|
|
return false;
|
| 203 |
|
|
}
|
| 204 |
|
|
|
| 205 |
|
|
/* Attempt to add the firewall rule if it doesn't exist.
|
| 206 |
|
|
* Failing to add the rule isn't necessarily an error, it may
|
| 207 |
|
|
* have been modified by the user in some way. Adding to the
|
| 208 |
|
|
* Alias is what's important.
|
| 209 |
|
|
*/
|
| 210 |
|
|
if (!easyrule_block_rule_exists($int)) {
|
| 211 |
|
|
if (easyrule_block_rule_create($int)) {
|
| 212 |
|
|
$dirty = true;
|
| 213 |
|
|
} else {
|
| 214 |
|
|
return false;
|
| 215 |
|
|
}
|
| 216 |
|
|
}
|
| 217 |
|
|
|
| 218 |
|
|
/* If needed, write the config and reload the filter */
|
| 219 |
|
|
if ($dirty) {
|
| 220 |
|
|
write_config();
|
| 221 |
|
|
$retval = filter_configure();
|
| 222 |
865ff9b4
|
jim-p
|
if (!empty($_SERVER['DOCUMENT_ROOT'])) {
|
| 223 |
|
|
header("Location: firewall_aliases.php");
|
| 224 |
|
|
exit;
|
| 225 |
|
|
} else {
|
| 226 |
|
|
return true;
|
| 227 |
|
|
}
|
| 228 |
c0b6fdde
|
jim-p
|
} else {
|
| 229 |
|
|
return false;
|
| 230 |
|
|
}
|
| 231 |
|
|
}
|
| 232 |
|
|
|
| 233 |
bd40781a
|
Seth Mos
|
function easyrule_pass_rule_add($int, $proto, $srchost, $dsthost, $dstport, $ipproto) {
|
| 234 |
c0b6fdde
|
jim-p
|
global $config;
|
| 235 |
|
|
|
| 236 |
|
|
/* No rules, start a new array */
|
| 237 |
|
|
if (!is_array($config['filter']['rule'])) {
|
| 238 |
|
|
$config['filter']['rule'] = array();
|
| 239 |
|
|
}
|
| 240 |
|
|
|
| 241 |
|
|
filter_rules_sort();
|
| 242 |
|
|
$a_filter = &$config['filter']['rule'];
|
| 243 |
|
|
|
| 244 |
|
|
/* Make up a new rule */
|
| 245 |
|
|
$filterent = array();
|
| 246 |
|
|
$filterent['type'] = 'pass';
|
| 247 |
|
|
$filterent['interface'] = $int;
|
| 248 |
bd40781a
|
Seth Mos
|
$filterent['ipprotocol'] = $ipproto;
|
| 249 |
5bd033a0
|
Renato Botelho
|
$filterent['descr'] = gettext("Easy Rule: Passed from Firewall Log View");
|
| 250 |
c0b6fdde
|
jim-p
|
|
| 251 |
|
|
if ($proto != "any")
|
| 252 |
|
|
$filterent['protocol'] = $proto;
|
| 253 |
|
|
else
|
| 254 |
|
|
unset($filterent['protocol']);
|
| 255 |
|
|
|
| 256 |
|
|
/* Default to only allow echo requests, since that's what most people want and
|
| 257 |
|
|
* it should be a safe choice. */
|
| 258 |
|
|
if ($proto == "icmp")
|
| 259 |
|
|
$filterent['icmptype'] = 'echoreq';
|
| 260 |
|
|
|
| 261 |
|
|
pconfig_to_address($filterent['source'], $srchost, 32);
|
| 262 |
|
|
pconfig_to_address($filterent['destination'], $dsthost, 32, '', $dstport, $dstport);
|
| 263 |
|
|
|
| 264 |
|
|
$a_filter[] = $filterent;
|
| 265 |
|
|
|
| 266 |
998f77a8
|
jim-p
|
write_config($filterent['descr']);
|
| 267 |
c0b6fdde
|
jim-p
|
$retval = filter_configure();
|
| 268 |
865ff9b4
|
jim-p
|
if (!empty($_SERVER['DOCUMENT_ROOT'])) {
|
| 269 |
|
|
header("Location: firewall_rules.php?if={$int}");
|
| 270 |
|
|
exit;
|
| 271 |
|
|
} else {
|
| 272 |
|
|
return true;
|
| 273 |
|
|
}
|
| 274 |
|
|
}
|
| 275 |
|
|
|
| 276 |
bd40781a
|
Seth Mos
|
function easyrule_parse_block($int, $src, $ipproto) {
|
| 277 |
|
|
$filterent['ipprotocol'] = $ipproto;
|
| 278 |
865ff9b4
|
jim-p
|
if (!empty($src) && !empty($int)) {
|
| 279 |
|
|
if (!is_ipaddr($src)) {
|
| 280 |
5bd033a0
|
Renato Botelho
|
return gettext("Tried to block invalid IP:") . ' ' . htmlspecialchars($src);
|
| 281 |
865ff9b4
|
jim-p
|
}
|
| 282 |
|
|
$int = easyrule_find_rule_interface($int);
|
| 283 |
|
|
if ($int === false) {
|
| 284 |
5bd033a0
|
Renato Botelho
|
return gettext("Invalid interface for block rule:") . ' ' . htmlspecialchars($int);
|
| 285 |
865ff9b4
|
jim-p
|
}
|
| 286 |
|
|
if (easyrule_block_host_add($src, $int)) {
|
| 287 |
5bd033a0
|
Renato Botelho
|
return gettext("Host added successfully");
|
| 288 |
865ff9b4
|
jim-p
|
} else {
|
| 289 |
5bd033a0
|
Renato Botelho
|
return gettext("Failed to create block rule, alias, or add host.");
|
| 290 |
865ff9b4
|
jim-p
|
}
|
| 291 |
|
|
} else {
|
| 292 |
5bd033a0
|
Renato Botelho
|
return gettext("Tried to block but had no host IP or interface");
|
| 293 |
865ff9b4
|
jim-p
|
}
|
| 294 |
5bd033a0
|
Renato Botelho
|
return gettext("Unknown block error.");
|
| 295 |
865ff9b4
|
jim-p
|
}
|
| 296 |
bd40781a
|
Seth Mos
|
function easyrule_parse_pass($int, $proto, $src, $dst, $dstport = 0, $ipproto = inet) {
|
| 297 |
865ff9b4
|
jim-p
|
/* Check for valid int, srchost, dsthost, dstport, and proto */
|
| 298 |
|
|
global $protocols_with_ports;
|
| 299 |
|
|
|
| 300 |
|
|
if (!empty($int) && !empty($proto) && !empty($src) && !empty($dst)) {
|
| 301 |
|
|
$int = easyrule_find_rule_interface($int);
|
| 302 |
|
|
if ($int === false) {
|
| 303 |
5bd033a0
|
Renato Botelho
|
return gettext("Invalid interface for pass rule:") . ' ' . htmlspecialchars($int);
|
| 304 |
865ff9b4
|
jim-p
|
}
|
| 305 |
|
|
if (getprotobyname($proto) == -1) {
|
| 306 |
5bd033a0
|
Renato Botelho
|
return gettext("Invalid protocol for pass rule:") . ' ' . htmlspecialchars($proto);
|
| 307 |
865ff9b4
|
jim-p
|
}
|
| 308 |
|
|
if (!is_ipaddr($src)) {
|
| 309 |
5bd033a0
|
Renato Botelho
|
return gettext("Tried to pass invalid source IP:") . ' ' . htmlspecialchars($src);
|
| 310 |
865ff9b4
|
jim-p
|
}
|
| 311 |
|
|
if (!is_ipaddr($dst)) {
|
| 312 |
5bd033a0
|
Renato Botelho
|
return gettext("Tried to pass invalid destination IP:") . ' ' . htmlspecialchars($dst);
|
| 313 |
865ff9b4
|
jim-p
|
}
|
| 314 |
|
|
if (in_array($proto, $protocols_with_ports)) {
|
| 315 |
|
|
if (empty($dstport)) {
|
| 316 |
5bd033a0
|
Renato Botelho
|
return gettext("Missing destination port:") . ' ' . htmlspecialchars($dstport);
|
| 317 |
865ff9b4
|
jim-p
|
}
|
| 318 |
|
|
if (!is_port($dstport)) {
|
| 319 |
5bd033a0
|
Renato Botelho
|
return gettext("Tried to pass invalid destination port:") . ' ' . htmlspecialchars($dstport);
|
| 320 |
865ff9b4
|
jim-p
|
}
|
| 321 |
|
|
} else {
|
| 322 |
|
|
$dstport = 0;
|
| 323 |
|
|
}
|
| 324 |
|
|
/* Should have valid input... */
|
| 325 |
bd40781a
|
Seth Mos
|
if (easyrule_pass_rule_add($int, $proto, $src, $dst, $dstport, $ipproto)) {
|
| 326 |
5bd033a0
|
Renato Botelho
|
return gettext("Successfully added pass rule!");
|
| 327 |
865ff9b4
|
jim-p
|
} else {
|
| 328 |
5bd033a0
|
Renato Botelho
|
return gettext("Failed to add pass rule.");
|
| 329 |
865ff9b4
|
jim-p
|
}
|
| 330 |
|
|
} else {
|
| 331 |
5bd033a0
|
Renato Botelho
|
return gettext("Missing parameters for pass rule.");
|
| 332 |
865ff9b4
|
jim-p
|
}
|
| 333 |
5bd033a0
|
Renato Botelho
|
return gettext("Unknown pass error.");
|
| 334 |
c0b6fdde
|
jim-p
|
}
|
| 335 |
9734b054
|
Scott Ullrich
|
|
| 336 |
bd40781a
|
Seth Mos
|
?>
|