From 962c388c58d95e2cbadca5d97fd6c22816776de9 Mon Sep 17 00:00:00 2001 From: Franco Fichtner Date: Wed, 31 May 2023 16:29:30 +0200 Subject: [PATCH] src: style sweep --- plist | 9 +++++ src/etc/inc/plugins.inc.d/openvpn.inc | 2 +- .../OPNsense/OpenVPN/Api/ExportController.php | 3 +- .../OpenVPN/Api/InstancesController.php | 1 - .../OpenVPN/Api/ServiceController.php | 2 +- .../OpenVPN/forms/dialogStaticKey.xml | 2 +- .../OpenVPN/FieldTypes/InstanceField.php | 2 +- .../OpenVPN/FieldTypes/RemoteHostField.php | 8 ++-- .../OpenVPN/FieldTypes/VPNIdField.php | 5 +-- .../app/models/OPNsense/OpenVPN/OpenVPN.php | 38 ++++++++++--------- .../app/views/OPNsense/OpenVPN/instances.volt | 1 - .../scripts/openvpn/ovpn_service_control.php | 1 - 12 files changed, 41 insertions(+), 33 deletions(-) diff --git a/plist b/plist index 5d95c7935..e9254bd53 100644 --- a/plist +++ b/plist @@ -390,11 +390,15 @@ /usr/local/opnsense/mvc/app/controllers/OPNsense/Monit/forms/tests.xml /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ClientOverwritesController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ExportController.php +/usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/InstancesController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ServiceController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/ClientOverwritesController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/ExportController.php +/usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/InstancesController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/StatusController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogCSO.xml +/usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogInstance.xml +/usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogStaticKey.xml /usr/local/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/export_options.xml /usr/local/opnsense/mvc/app/controllers/OPNsense/Proxy/Api/ServiceController.php /usr/local/opnsense/mvc/app/controllers/OPNsense/Proxy/Api/SettingsController.php @@ -661,7 +665,10 @@ /usr/local/opnsense/mvc/app/models/OPNsense/Ntpd/Menu/Menu.xml /usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/Export.php /usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/Export.xml +/usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/InstanceField.php /usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/OpenVPNServerField.php +/usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/RemoteHostField.php +/usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/VPNIdField.php /usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/Migrations/M1_0_0.php /usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.php /usr/local/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.xml @@ -746,6 +753,7 @@ /usr/local/opnsense/mvc/app/views/OPNsense/Monit/status.volt /usr/local/opnsense/mvc/app/views/OPNsense/OpenVPN/cso.volt /usr/local/opnsense/mvc/app/views/OPNsense/OpenVPN/export.volt +/usr/local/opnsense/mvc/app/views/OPNsense/OpenVPN/instances.volt /usr/local/opnsense/mvc/app/views/OPNsense/OpenVPN/status.volt /usr/local/opnsense/mvc/app/views/OPNsense/Proxy/index.volt /usr/local/opnsense/mvc/app/views/OPNsense/Routes/index.volt @@ -968,6 +976,7 @@ /usr/local/opnsense/scripts/openvpn/client_disconnect.sh /usr/local/opnsense/scripts/openvpn/kill_session.py /usr/local/opnsense/scripts/openvpn/ovpn_event.py +/usr/local/opnsense/scripts/openvpn/ovpn_service_control.php /usr/local/opnsense/scripts/openvpn/ovpn_status.py /usr/local/opnsense/scripts/openvpn/tls_verify.php /usr/local/opnsense/scripts/openvpn/user_pass_verify.php diff --git a/src/etc/inc/plugins.inc.d/openvpn.inc b/src/etc/inc/plugins.inc.d/openvpn.inc index 801950274..ef731ddaf 100644 --- a/src/etc/inc/plugins.inc.d/openvpn.inc +++ b/src/etc/inc/plugins.inc.d/openvpn.inc @@ -213,7 +213,7 @@ function openvpn_create_key() function openvpn_vpnid_next() { $vpnids = (new OPNsense\OpenVPN\OpenVPN())->usedVPNIds(); - for ($vpnid = 1; true ; $vpnid++) { + for ($vpnid = 1; true; $vpnid++) { if (!in_array($vpnid, $vpnids)) { return $vpnid; } diff --git a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ExportController.php b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ExportController.php index 9feef9dc6..568e39462 100644 --- a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ExportController.php +++ b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ExportController.php @@ -111,7 +111,7 @@ class ExportController extends ApiControllerBase } } } - foreach ((new OpenVPN())->Instances->Instance->iterateItems() as $node_uuid => $node){ + foreach ((new OpenVPN())->Instances->Instance->iterateItems() as $node_uuid => $node) { if (!empty((string)$node->enabled) && $node->role == 'server') { $name = empty($node->description) ? "server" : (string)$node->description; $name .= " " . $node->proto . ":" . $node->port; @@ -122,7 +122,6 @@ class ExportController extends ApiControllerBase ]; } } - } /** diff --git a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/InstancesController.php b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/InstancesController.php index 59de1f5e2..678e5f0d6 100644 --- a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/InstancesController.php +++ b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/InstancesController.php @@ -31,7 +31,6 @@ namespace OPNsense\OpenVPN\Api; use OPNsense\Base\ApiMutableModelControllerBase; use OPNsense\Core\Backend; - /** * Class InstancesController * @package OPNsense\OpenVPN\Api diff --git a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ServiceController.php b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ServiceController.php index 530657776..6b9bbfa51 100644 --- a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ServiceController.php +++ b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/Api/ServiceController.php @@ -54,7 +54,7 @@ class ServiceController extends ApiControllerBase } } } - foreach ((new OpenVPN())->Instances->Instance->iterateItems() as $node_uuid => $node){ + foreach ((new OpenVPN())->Instances->Instance->iterateItems() as $node_uuid => $node) { $config_payload[$node_uuid] = [ 'enabled' => (string)$node->enabled, 'description' => (string)$node->description diff --git a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogStaticKey.xml b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogStaticKey.xml index f1a9d2a84..15fe05911 100644 --- a/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogStaticKey.xml +++ b/src/opnsense/mvc/app/controllers/OPNsense/OpenVPN/forms/dialogStaticKey.xml @@ -18,4 +18,4 @@ textbox Paste an OpenVPN Static key. Or generate one with the button. - \ No newline at end of file + diff --git a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/InstanceField.php b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/InstanceField.php index e6cfbd0aa..7159872bc 100644 --- a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/InstanceField.php +++ b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/InstanceField.php @@ -48,7 +48,7 @@ class InstanceField extends ArrayField 'statFilename' => "/var/etc/openvpn/instance-{$uuid}.stat", 'csoDirectory' => "/var/etc/openvpn-csc/$node->vpnid", '__devnode' => "{$node->dev_type}{$node->vpnid}", - '__devname' => "ovpn".((string)$node->role)[0]."{$node->vpnid}", + '__devname' => "ovpn" . ((string)$node->role)[0] . "{$node->vpnid}", ]; foreach ($files as $name => $payload) { $new_item = new TextField(); diff --git a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/RemoteHostField.php b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/RemoteHostField.php index ffaadc726..b6bdaa1a8 100644 --- a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/RemoteHostField.php +++ b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/RemoteHostField.php @@ -60,7 +60,7 @@ class RemoteHostField extends BaseField if ($this->internalValue != null) { $validators[] = new CallbackValidator( [ - "callback" => function ($value) { + "callback" => function ($value) { $errors = []; foreach (explode(',', $value) as $this_remote) { $parts = []; @@ -78,7 +78,9 @@ class RemoteHostField extends BaseField $errors[] = sprintf(gettext("hostname %s is not a valid hostname."), $parts[0]); } elseif ( isset($parts[1]) && - filter_var($parts[1], FILTER_VALIDATE_INT, + filter_var( + $parts[1], + FILTER_VALIDATE_INT, ['options' => ['min_range' => 1, 'max_range' => 65535]] ) === false ) { @@ -92,4 +94,4 @@ class RemoteHostField extends BaseField } return $validators; } -} \ No newline at end of file +} diff --git a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/VPNIdField.php b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/VPNIdField.php index abb36d663..d5d5e8abd 100644 --- a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/VPNIdField.php +++ b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/FieldTypes/VPNIdField.php @@ -31,7 +31,6 @@ namespace OPNsense\OpenVPN\FieldTypes; use OPNsense\Base\Validators\CallbackValidator; use OPNsense\Base\FieldTypes\IntegerField; - /** * @package OPNsense\Base\FieldTypes */ @@ -56,7 +55,7 @@ class VPNIdField extends IntegerField { if ($value == '') { // enforce default when not set - for ($i = 1; true ; $i++) { + for ($i = 1; true; $i++) { if (!in_array($i, self::$internalLegacyVPNids)) { $this->internalValue = (string)$i; $this_uuid = $this->getParentNode()->getAttributes()['uuid']; @@ -81,7 +80,7 @@ class VPNIdField extends IntegerField $validators[] = new CallbackValidator( [ - "callback" => function ($value) use ($vpnids, $this_uuid) { + "callback" => function ($value) use ($vpnids, $this_uuid) { foreach ($vpnids as $key => $vpnid) { if ($vpnid == $value && $key != $this_uuid) { return [gettext('Value should be unique')]; diff --git a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.php b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.php index 0fc07fa27..45ebc97ee 100644 --- a/src/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.php +++ b/src/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.php @@ -34,7 +34,6 @@ use OPNsense\Trust\Store; use OPNsense\Core\Config; use OPNsense\Firewall\Util; - /** * Class OpenVPN * @package OPNsense\OpenVPN @@ -80,7 +79,8 @@ class OpenVPN extends BaseModel $tmp = Store::getCertificate((string)$instance->cert); if (empty($tmp) || !isset($tmp['ca'])) { $messages->appendMessage(new Message( - gettext("Unable to locate a Certificate Authority for this certificate"), $key . ".cert" + gettext("Unable to locate a Certificate Authority for this certificate"), + $key . ".cert" )); } } @@ -92,19 +92,22 @@ class OpenVPN extends BaseModel ) { if ((string)$node->verify_client_cert != 'none') { $messages->appendMessage(new Message( - gettext("To validate a certificate, one has to be provided "), $key . ".verify_client_cert" + gettext("To validate a certificate, one has to be provided "), + $key . ".verify_client_cert" )); } } } - if (( + if ( + ( $instance->keepalive_interval->isFieldChanged() || $instance->keepalive_timeout->isFieldChanged() || $validateFullModel ) && (int)(string)$instance->keepalive_timeout < (int)(string)$instance->keepalive_interval ) { $messages->appendMessage(new Message( - gettext("Timeout should be larger than interval"), $key . ".keepalive_timeout" + gettext("Timeout should be larger than interval"), + $key . ".keepalive_timeout" )); } } @@ -191,7 +194,7 @@ class OpenVPN extends BaseModel } } } - foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node){ + foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node) { if ((string)$node->vpnid != '') { $result[$node_uuid] = (string)$node->vpnid; } @@ -214,13 +217,12 @@ class OpenVPN extends BaseModel } } } - foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node){ + foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node) { if (!empty((string)$node->enabled)) { return true; } } return false; - } /** @@ -229,10 +231,10 @@ class OpenVPN extends BaseModel * @param string $server_id vpnid (either numerical or uuid) * @return array selection of relevant fields for downstream processes */ - public function getInstanceById($server_id, $role=null) + public function getInstanceById($server_id, $role = null) { // travers model first, two key types are valid, the id used in the device (numeric) or the uuid - foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node){ + foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node) { if ( !empty((string)$node->enabled) && ((string)$node->vpnid == $server_id || $server_id == $node_uuid) && @@ -333,22 +335,22 @@ class OpenVPN extends BaseModel if ($value === null) { $output .= $key . "\n"; } elseif (str_starts_with($key, '<')) { - $output .= $key ."\n"; - $output .= trim($value)."\n"; + $output .= $key . "\n"; + $output .= trim($value) . "\n"; $output .= "Instances->Instance->iterateItems() as $node_uuid => $node){ + foreach ($this->Instances->Instance->iterateItems() as $node_uuid => $node) { if (!empty((string)$node->enabled) && ($uuid == null || $node_uuid == $uuid)) { $options = ['push' => [], 'route' => [], 'route-ipv6' => []]; // mode specific settings diff --git a/src/opnsense/mvc/app/views/OPNsense/OpenVPN/instances.volt b/src/opnsense/mvc/app/views/OPNsense/OpenVPN/instances.volt index e7a6cb9fe..a9f42a6b4 100644 --- a/src/opnsense/mvc/app/views/OPNsense/OpenVPN/instances.volt +++ b/src/opnsense/mvc/app/views/OPNsense/OpenVPN/instances.volt @@ -168,4 +168,3 @@ {{ partial("layout_partials/base_dialog",['fields':formDialogInstance,'id':'DialogInstance','label':lang._('Edit Instance')])}} {{ partial("layout_partials/base_dialog",['fields':formDialogStaticKey,'id':'DialogStaticKey','label':lang._('Edit Static Key')])}} - diff --git a/src/opnsense/scripts/openvpn/ovpn_service_control.php b/src/opnsense/scripts/openvpn/ovpn_service_control.php index 489d9449a..ca15bbb6a 100755 --- a/src/opnsense/scripts/openvpn/ovpn_service_control.php +++ b/src/opnsense/scripts/openvpn/ovpn_service_control.php @@ -180,4 +180,3 @@ if (isset($opts['h']) || empty($args) || !in_array($args[0], ['start', 'stop', ' } closelog(); } -