From 69d6a46810fa2816263bfb141d0a24d4577c630b Mon Sep 17 00:00:00 2001
From: Monviech <79600909+Monviech@users.noreply.github.com>
Date: Fri, 25 Oct 2024 16:11:07 +0200
Subject: [PATCH] vpn: ipsec: Add description field to pre-shared-keys (#8015)

---
 .../OPNsense/IPsec/Api/PreSharedKeysController.php           | 2 +-
 .../mvc/app/controllers/OPNsense/IPsec/forms/dialogPSK.xml   | 5 +++++
 src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml         | 1 +
 .../mvc/app/views/OPNsense/IPsec/pre_shared_keys.volt        | 1 +
 4 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/opnsense/mvc/app/controllers/OPNsense/IPsec/Api/PreSharedKeysController.php b/src/opnsense/mvc/app/controllers/OPNsense/IPsec/Api/PreSharedKeysController.php
index 4a66bee16..ae09d410f 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/IPsec/Api/PreSharedKeysController.php
+++ b/src/opnsense/mvc/app/controllers/OPNsense/IPsec/Api/PreSharedKeysController.php
@@ -46,7 +46,7 @@ class PreSharedKeysController extends ApiMutableModelControllerBase
      */
     public function searchItemAction()
     {
-        return $this->searchBase('preSharedKeys.preSharedKey', ['ident', 'remote_ident', 'keyType']);
+        return $this->searchBase('preSharedKeys.preSharedKey', ['ident', 'remote_ident', 'keyType', 'description']);
     }
 
     /**
diff --git a/src/opnsense/mvc/app/controllers/OPNsense/IPsec/forms/dialogPSK.xml b/src/opnsense/mvc/app/controllers/OPNsense/IPsec/forms/dialogPSK.xml
index 27b63716e..af427074b 100644
--- a/src/opnsense/mvc/app/controllers/OPNsense/IPsec/forms/dialogPSK.xml
+++ b/src/opnsense/mvc/app/controllers/OPNsense/IPsec/forms/dialogPSK.xml
@@ -21,4 +21,9 @@
         <label>Type</label>
         <type>dropdown</type>
     </field>
+    <field>
+        <id>preSharedKey.description</id>
+        <label>Description</label>
+        <type>text</type>
+    </field>
 </form>
diff --git a/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml b/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml
index fa279755a..603b6b56e 100644
--- a/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml
+++ b/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml
@@ -146,6 +146,7 @@
                     </OptionValues>
                 </keyType>
                 <Key type="TextField"/>
+                <description type="DescriptionField"/>
             </preSharedKey>
         </preSharedKeys>
     </items>
diff --git a/src/opnsense/mvc/app/views/OPNsense/IPsec/pre_shared_keys.volt b/src/opnsense/mvc/app/views/OPNsense/IPsec/pre_shared_keys.volt
index a584ecf71..9e9a39ffa 100644
--- a/src/opnsense/mvc/app/views/OPNsense/IPsec/pre_shared_keys.volt
+++ b/src/opnsense/mvc/app/views/OPNsense/IPsec/pre_shared_keys.volt
@@ -20,6 +20,7 @@
               <th data-column-id="ident" data-type="string">{{ lang._('Local Identifier') }}</th>
               <th data-column-id="remote_ident" data-type="string">{{ lang._('Remote Identifier') }}</th>
               <th data-column-id="keyType" data-width="20em" data-type="string">{{ lang._('Key Type') }}</th>
+              <th data-column-id="description" data-type="string">{{ lang._('Description') }}</th>
               <th data-column-id="commands" data-width="7em" data-formatter="commands" data-sortable="false">{{ lang._('Commands') }}</th>
           </tr>
       </thead>