From 71afeecb2b0abac2fe67f30983394d64b0c1c738 Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Sun, 11 Jul 2021 14:13:19 +0200
Subject: [PATCH] net-mgmt/zabbix-agent: use "NetworkField" wherever applicable

---
 net-mgmt/zabbix-agent/pkg-descr                 |  3 +++
 .../OPNsense/ZabbixAgent/forms/settings.xml     |  5 +++--
 .../models/OPNsense/ZabbixAgent/ZabbixAgent.xml | 17 +++++++++--------
 3 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/net-mgmt/zabbix-agent/pkg-descr b/net-mgmt/zabbix-agent/pkg-descr
index 88a569858..58fa72932 100644
--- a/net-mgmt/zabbix-agent/pkg-descr
+++ b/net-mgmt/zabbix-agent/pkg-descr
@@ -17,6 +17,9 @@ Plugin Changelog
 Added:
 * Allow CIDR notation in "Zabbix Servers" field (#2296)
 
+Changed:
+* Use "NetworkField" wherever applicable for better input validation
+
 1.8
 
 Added:
diff --git a/net-mgmt/zabbix-agent/src/opnsense/mvc/app/controllers/OPNsense/ZabbixAgent/forms/settings.xml b/net-mgmt/zabbix-agent/src/opnsense/mvc/app/controllers/OPNsense/ZabbixAgent/forms/settings.xml
index 8618b5378..406ae29a4 100644
--- a/net-mgmt/zabbix-agent/src/opnsense/mvc/app/controllers/OPNsense/ZabbixAgent/forms/settings.xml
+++ b/net-mgmt/zabbix-agent/src/opnsense/mvc/app/controllers/OPNsense/ZabbixAgent/forms/settings.xml
@@ -31,7 +31,8 @@
             <id>zabbixagent.settings.main.sourceIP</id>
             <label>Source IP</label>
             <type>text</type>
-            <help><![CDATA[Source IP address for outgoing connections.]]></help>
+            <hint>Optional</hint>
+            <help><![CDATA[An optional source IP address for outgoing connections.]]></help>
         </field>
         <field>
             <id>zabbixagent.settings.main.serverList</id>
@@ -112,7 +113,7 @@
             <type>select_multiple</type>
             <style>tokenize</style>
             <allownew>true</allownew>
-            <help><![CDATA[List of IP:port (or hostname:port) pairs of Zabbix servers for active checks. If port is not specified, default port is used. IPv6 addresses must be enclosed in square brackets if port for that host is specified. If port is not specified, square brackets for IPv6 addresses are optional. If this parameter is not specified, active checks are disabled. Example: ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]]]></help>
+            <help><![CDATA[List of IP:port (or hostname:port) pairs of Zabbix servers for active checks. If port is not specified, the default port is used. IPv6 addresses must be enclosed in square brackets if the port for that host is specified. If the port is not specified, square brackets for IPv6 addresses are optional. If this parameter is not specified, active checks are disabled. Examples: zabbix.example.com, 10.0.0.2:20051, [::1]:30051,::1, [12fc::1]]]></help>
         </field>
         <field>
             <id>zabbixagent.settings.features.refreshActiveChecks</id>
diff --git a/net-mgmt/zabbix-agent/src/opnsense/mvc/app/models/OPNsense/ZabbixAgent/ZabbixAgent.xml b/net-mgmt/zabbix-agent/src/opnsense/mvc/app/models/OPNsense/ZabbixAgent/ZabbixAgent.xml
index 346cba846..bf622ad70 100644
--- a/net-mgmt/zabbix-agent/src/opnsense/mvc/app/models/OPNsense/ZabbixAgent/ZabbixAgent.xml
+++ b/net-mgmt/zabbix-agent/src/opnsense/mvc/app/models/OPNsense/ZabbixAgent/ZabbixAgent.xml
@@ -24,7 +24,7 @@
                     <multiple>Y</multiple>
                     <mask>/^([a-zA-Z0-9\.:\[\]\-\/]*?,)*([a-zA-Z0-9\.:\[\]\-\/]*)$/</mask>
                     <ChangeCase>lower</ChangeCase>
-                    <ValidationMessage>Please provide valid Zabbix server addresses, i.e. 10.0.0.1 or zabbix.example.com.</ValidationMessage>
+                    <ValidationMessage>Please provide valid Zabbix server addresses, i.e. zabbix.example.com, 10.0.0.2 or 10.0.0.0/24.</ValidationMessage>
                 </serverList>
                 <listenPort type="IntegerField">
                     <default>10050</default>
@@ -32,18 +32,19 @@
                     <MaximumValue>65535</MaximumValue>
                     <Required>Y</Required>
                 </listenPort>
-                <listenIP type="CSVListField">
+                <listenIP type="NetworkField">
                     <default>0.0.0.0</default>
                     <Required>Y</Required>
                     <multiple>Y</multiple>
-                    <mask>/^((([0-9a-zA-Z._\-\*:]+)([,]){0,1}))*/u</mask>
-                    <ChangeCase>lower</ChangeCase>
-                    <ValidationMessage>Please provide valid IP addresses, i.e. 10.0.0.1.</ValidationMessage>
+                    <NetMaskAllowed>N</NetMaskAllowed>
+                    <asList>Y</asList>
+                    <FieldSeparator>,</FieldSeparator>
+                    <ValidationMessage>Please provide one or more valid IP addresses, i.e. 10.0.0.1.</ValidationMessage>
                 </listenIP>
-                <sourceIP type="TextField">
+                <sourceIP type="NetworkField">
                     <Required>N</Required>
-                    <mask>/^.{1,255}$/u</mask>
-                    <ValidationMessage>Should be a string between 1 and 255 characters.</ValidationMessage>
+                    <NetMaskAllowed>N</NetMaskAllowed>
+                    <ValidationMessage>Please provide a valid IP address, i.e. 10.0.0.1.</ValidationMessage>
                 </sourceIP>
                 <logFileSize type="IntegerField">
                     <default>100</default>