From 0f6b29f5bbe15e7bf3b2e276f36e4921626d2e1e Mon Sep 17 00:00:00 2001
From: Ad Schellevis <ad@opnsense.org>
Date: Mon, 28 Jan 2019 21:30:14 +0100
Subject: [PATCH] MVC, PortField, add range validation and implement in
 TrafficShaper.xml, closes https://github.com/opnsense/core/issues/3162

---
 .../OPNsense/Base/FieldTypes/PortField.php    | 55 +++++++++++++++----
 .../OPNsense/TrafficShaper/TrafficShaper.xml  |  2 +
 2 files changed, 47 insertions(+), 10 deletions(-)

diff --git a/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/PortField.php b/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/PortField.php
index 45d69021d..4f535f1e9 100644
--- a/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/PortField.php
+++ b/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/PortField.php
@@ -30,6 +30,7 @@
 namespace OPNsense\Base\FieldTypes;
 
 use Phalcon\Validation\Validator\InclusionIn;
+use OPNsense\Base\Validators\CallbackValidator;
 
 /**
  * Class PortField field type for ports, includes validation for services in /etc/services or valid number ranges.
@@ -98,6 +99,11 @@ class PortField extends BaseField
      */
     private $enableWellKown = false;
 
+    /**
+     * @var bool enable port ranges
+     */
+    private $enableRanges = false;
+
     /**
      * @var array collected options
      */
@@ -125,11 +131,16 @@ class PortField extends BaseField
      */
     public function setEnableWellKnown($value)
     {
-        if (strtoupper(trim($value)) == "Y") {
-            $this->enableWellKown = true;
-        } else {
-            $this->enableWellKown = false;
-        }
+        $this->enableWellKown =  (strtoupper(trim($value)) == "Y");
+    }
+
+    /**
+     * setter for maximum value
+     * @param integer $value
+     */
+    public function setEnableRanges($value)
+    {
+        $this->enableRanges =  (strtoupper(trim($value)) == "Y");
     }
 
     /**
@@ -142,12 +153,10 @@ class PortField extends BaseField
     }
 
     /**
-     * retrieve field validators for this field type
-     * @return array returns InclusionIn validator
+     * return validation message
      */
-    public function getValidators()
+    private function getValidationMessage()
     {
-        $validators = parent::getValidators();
         if ($this->internalValidationMessage == null) {
             $msg = gettext('Please specify a valid port number (1-65535).');
             if ($this->enableWellKown) {
@@ -156,10 +165,36 @@ class PortField extends BaseField
         } else {
             $msg = $this->internalValidationMessage;
         }
+        return $msg;
+    }
 
+    /**
+     * retrieve field validators for this field type
+     * @return array returns InclusionIn validator
+     */
+    public function getValidators()
+    {
+        $validators = parent::getValidators();
         if (($this->internalIsRequired == true || $this->internalValue != null) &&
             count(self::$internalOptionList) > 0) {
-            $validators[] = new InclusionIn(array('message' => $msg,'domain'=>self::$internalOptionList));
+            if (count(explode("-", $this->internalValue)) == 2 && $this->enableRanges) {
+                // range validation
+                $validators[] = new CallbackValidator(["callback" => function ($data) {
+                    $messages = [];
+                    $tmp = explode('-', $data);
+                    foreach ($tmp as $port) {
+                        if (filter_var($port, FILTER_VALIDATE_INT,
+                              array("options" => array("min_range"=>1, "max_range"=>65535))) === false) {
+                            $messages[] = $this->getValidationMessage();
+                            break;
+                        }
+                    }
+                    return $messages;
+                }]);
+            } else {
+                $validators[] = new InclusionIn(array('message' => $this->getValidationMessage(),
+                                                      'domain'=>self::$internalOptionList));
+            }
         }
         return $validators;
     }
diff --git a/src/opnsense/mvc/app/models/OPNsense/TrafficShaper/TrafficShaper.xml b/src/opnsense/mvc/app/models/OPNsense/TrafficShaper/TrafficShaper.xml
index a8b458acc..a0fdc6b5a 100644
--- a/src/opnsense/mvc/app/models/OPNsense/TrafficShaper/TrafficShaper.xml
+++ b/src/opnsense/mvc/app/models/OPNsense/TrafficShaper/TrafficShaper.xml
@@ -286,6 +286,7 @@
                 <src_port type="PortField">
                     <Required>Y</Required>
                     <EnableWellKnown>Y</EnableWellKnown>
+                    <EnableRanges>Y</EnableRanges>
                     <default>any</default>
                 </src_port>
                 <destination type="NetworkField">
@@ -301,6 +302,7 @@
                 <dst_port type="PortField">
                     <Required>Y</Required>
                     <EnableWellKnown>Y</EnableWellKnown>
+                    <EnableRanges>Y</EnableRanges>
                     <default>any</default>
                 </dst_port>
                 <direction type="OptionField">