lucaspalomodevelop/core
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/core.git synced 2026-03-13 08:09:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Firewall: Aliases - offer better pluggability for dynamic alias types and move current json static_aliases and interface networks into their own classes.

Browse Source 
When services offer aliases which are less static, the current json option isn't very practical as we only want the package manager to ship files into these directories.
The new DynamicAliases namespace may contain simple php classes, which return a named set of aliases to merge into the set.

Since all of these classes are created on each alias query, it's highly advisable to keep their implementations as lightweight as possible.
This commit is contained in:
Ad Schellevis 2025-02-19 15:59:30 +01:00
parent 2cc36105da
commit fdded458e0
6 changed files with 140 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
plist
View File

@ -731,6 +731,9 @@
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/Alias.xml
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/Category.php
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/Category.xml
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/DynamicAliases/InterfaceNetworkAliases.php
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/DynamicAliases/README.md
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/DynamicAliases/StaticAliases.php
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/FieldTypes/AliasContentField.php
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/FieldTypes/AliasField.php
/usr/local/opnsense/mvc/app/models/OPNsense/Firewall/FieldTypes/AliasNameField.php

2
src/opnsense/mvc/app/models/OPNsense/Firewall/Alias.php
View File

@ -1,7 +1,7 @@
<?php
/**
* Copyright (C) 2018 Deciso B.V.
* Copyright (C) 2018-2025 Deciso B.V.
*
* All rights reserved.
*

54
src/opnsense/mvc/app/models/OPNsense/Firewall/DynamicAliases/InterfaceNetworkAliases.php Normal file
View File

@ -0,0 +1,54 @@
<?php
/**
* Copyright (C) 2025 Deciso B.V.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
namespace OPNsense\Firewall\DynamicAliases;
use OPNsense\Core\Config;
class InterfaceNetworkAliases
{
public function collect()
{
$result = [];
foreach (Config::getInstance()->object()->interfaces->children() as $k => $n) {
$table_name = sprintf("__%s_network", $k);
$table_desc = !empty((string)$n->descr) ? (string)$n->descr : $k;
$result[$table_name] = [
"enabled" => "1",
"name" => $table_name,
"type" => "internal",
"description" => sprintf("%s %s", $table_desc, gettext("net")),
"content" => ""
];
}
return $result;
}
}

11
src/opnsense/mvc/app/models/OPNsense/Firewall/DynamicAliases/README.md Normal file
View File

@ -0,0 +1,11 @@
DynamicAliases
========================
This namespace may contain simple classes which generate aliases that should be merged automatically in Firewall/Aliases.
Each class should have a `collect()` method returning a named array with alias registration info.
An easy example of the expected result can be found in `../static_aliases/core.json`
** Note: make sure actions are "light weight" to prevent excessive api execution times.

46
src/opnsense/mvc/app/models/OPNsense/Firewall/DynamicAliases/StaticAliases.php Normal file
View File

@ -0,0 +1,46 @@
<?php
/**
* Copyright (C) 2025 Deciso B.V.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
namespace OPNsense\Firewall\DynamicAliases;
class StaticAliases
{
public function collect()
{
$result = [];
foreach (glob(__DIR__ . "/../static_aliases/*.json") as $filename) {
$payload = json_decode(file_get_contents($filename), true);
if (is_array($payload)) {
$result = array_merge($result, $payload);
}
}
return $result;
}
}

45
src/opnsense/mvc/app/models/OPNsense/Firewall/FieldTypes/AliasField.php
View File

@ -1,7 +1,7 @@
<?php
/**
* Copyright (C) 2020 Deciso B.V.
* Copyright (C) 2020-2025 Deciso B.V.
*
* All rights reserved.
*
@ -30,11 +30,11 @@
namespace OPNsense\Firewall\FieldTypes;
use ReflectionClass;
use ReflectionException;
use OPNsense\Base\FieldTypes\ArrayField;
use OPNsense\Base\FieldTypes\TextField;
use OPNsense\Base\FieldTypes\IntegerField;
use OPNsense\Core\Backend;
use OPNsense\Core\Config;
class AliasField extends ArrayField
{
@ -51,28 +51,33 @@ class AliasField extends ArrayField
protected static function getStaticChildren()
{
$result = [];
foreach (glob(__DIR__ . "/../static_aliases/*.json") as $filename) {
$payload = json_decode(file_get_contents($filename), true);
if (is_array($payload)) {
foreach ($payload as $aliasname => $content) {
$result[$aliasname] = $content;
foreach (glob(__DIR__ . "/../DynamicAliases/*.php") as $filename) {
$origin = explode('.', basename($filename))[0];
$classname = 'OPNsense\\Firewall\\DynamicAliases\\' . $origin;
try {
$obj = (new ReflectionClass($classname))->newInstance();
$payload = $obj->collect();
if (is_array($payload)) {
foreach ($payload as $aliasname => $content) {
/* XXX: will overwrite when exists */
$result[$aliasname] = $content;
}
}
} catch (\Error | \Exception | ReflectionException $e) {
syslog(LOG_ERR, sprintf(
"Invalid DynamicAliases object %s in %s (%s)",
$classname,
realpath($filename),
$e->getMessage()
));
}
}
foreach (Config::getInstance()->object()->interfaces->children() as $k => $n) {
$table_name = sprintf("__%s_network", $k);
$table_desc = !empty((string)$n->descr) ? (string)$n->descr : $k;
$result[$table_name] = [
"enabled" => "1",
"name" => $table_name,
"type" => "internal",
"description" => sprintf("%s %s", $table_desc, gettext("net")),
"content" => ""
];
}
return $result;
}
/**
* {@inheritdoc}
*/
protected function actionPostLoadingEvent()
{
parent::actionPostLoadingEvent();