From de9f860fdd52209082ee37c1718949d5c1f2dfa7 Mon Sep 17 00:00:00 2001
From: Stephan de Wit <stephan.dewt@yahoo.co.uk>
Date: Mon, 11 Apr 2022 16:30:10 +0200
Subject: [PATCH] Unbound / Domain overrides: accept _msdcs since legacy
 supported it. Closes #5697

---
 .../Unbound/FieldTypes/UnboundDomainField.php | 72 +++++++++++++++++++
 .../app/models/OPNsense/Unbound/Unbound.xml   |  3 +-
 2 files changed, 73 insertions(+), 2 deletions(-)
 create mode 100755 src/opnsense/mvc/app/models/OPNsense/Unbound/FieldTypes/UnboundDomainField.php

diff --git a/src/opnsense/mvc/app/models/OPNsense/Unbound/FieldTypes/UnboundDomainField.php b/src/opnsense/mvc/app/models/OPNsense/Unbound/FieldTypes/UnboundDomainField.php
new file mode 100755
index 000000000..329f21ac3
--- /dev/null
+++ b/src/opnsense/mvc/app/models/OPNsense/Unbound/FieldTypes/UnboundDomainField.php
@@ -0,0 +1,72 @@
+<?php
+
+/**
+ *    Copyright (C) 2022 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\Unbound\FieldTypes;
+
+use OPNsense\Base\FieldTypes\BaseField;
+use OPNsense\Base\Validators\CallbackValidator;
+use OPNsense\Firewall\Util;
+
+/**
+ * Class UnboundDomainField
+ * @package OPNsense\Unbound\FieldTypes
+ */
+class UnboundDomainField extends BaseField
+{
+
+    protected $internalIsContainer = false;
+
+    public function getValidators()
+    {
+        /**
+         * XXX: the only reason this class exists is to be compatible with
+         * legacy code allowing '_msdcs' domain prefixes. This is weird, not
+         * conforming to any standard and should probably be looked into further.
+         */
+        $validators = parent::getValidators();
+        if ($this->internalValue != null) {
+            $validators[] = new CallbackValidator([
+                "callback" => function($data) {
+                    if (substr($data, 0, 6) == '_msdcs') {
+                        $subdomain = substr($data, 7);
+                        if (substr($data, 6, 1) != '.' || !Util::isDomain($subdomain)) {
+                            return [gettext("A valid domain must be specified after '_msdcs', prefixed with a dot")];
+                        }
+                    } elseif (!Util::isDomain($data)) {
+                        return [gettext("A valid domain must be specified")];
+                    }
+                    return [];
+                }
+            ]);
+        }
+
+        return $validators;
+    }
+}
diff --git a/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml b/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml
index 1cf57ff90..6223507b2 100644
--- a/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml
+++ b/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml
@@ -226,9 +226,8 @@
                     <default>1</default>
                     <Required>Y</Required>
                 </enabled>
-                <domain type="TextField">
+                <domain type=".\UnboundDomainField">
                     <Required>Y</Required>
-                    <mask>/^(?:(?:[a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*(?:[a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$/i</mask>
                     <ValidationMessage>A valid domain must be specified.</ValidationMessage>
                 </domain>
                 <server type=".\UnboundServerField">