Added new Port Security polling module, API and WebUI info (librenms#18296)

* Added new Port Security polling module, API and WebUI info

* Remove some additional table heading

* Debug fix, api fix and ci fixes

* CI fixes

* CI fixes

* CI fixes

* CI fixes

* CI fixes

* Updated schema file

* Added test data

* Updated test data and default options

* Update os_schema.json to accept new poller module

* Derp, wrong section

* Converted main search page to laravel

* CI Fix

Author: laf

LibreNMS/Enum/PortSecurityStatus.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * PortSecurityStatus.php
+ *
+ * Enumerates Port Security Status with color mappings
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * @link       https://www.librenms.org
+ */
+
+namespace LibreNMS\Enum;
+
+class PortSecurityStatus
+{
+    const SECURE_UP = 'secureup';
+    const SECURE_DOWN = 'securedown';
+    const SHUTDOWN = 'shutdown';
+
+    const COLORS = [
+        self::SECURE_UP => 'green',
+        self::SECURE_DOWN => 'orange',
+        self::SHUTDOWN => 'red',
+    ];
+
+    /**
+     * Get the icon class for a given port security status
+     *
+     * @param  string  $status
+     * @return string
+     */
+    public static function getIconClass(string $status): string
+    {
+        $color = self::COLORS[$status] ?? null;
+
+        if ($color === null) {
+            return 'fa-shield';
+        }
+
+        $colorMap = [
+            'green' => 'tw:text-green-600',
+            'orange' => 'tw:text-orange-600',
+            'red' => 'tw:text-red-600',
+        ];
+
+        return 'fa-shield ' . $colorMap[$color];
+    }
+}

LibreNMS/Interfaces/Discovery/PortSecurityDiscovery.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * VminfoDiscovery.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2024 Michael Adams
+ * @author     Michael Adams <[email protected]>
+ */
+
+namespace LibreNMS\Interfaces\Discovery;
+
+use App\Models\PortSecurity;
+use Illuminate\Support\Collection;
+
+interface PortSecurityDiscovery
+{
+    /**
+     * Discover port-security info
+     *
+     * @return Collection<PortSecurity>
+     */
+    public function discoverPortSecurity(): Collection;
+}

LibreNMS/Interfaces/Polling/PortSecurityPolling.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * PortSecurityPolling.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2023 Tony Murray
+ * @author     Tony Murray <[email protected]>
+ */
+
+namespace LibreNMS\Interfaces\Polling;
+
+use App\Models\PortSecurity;
+use Illuminate\Support\Collection;
+
+interface PortSecurityPolling
+{
+    /**
+     * Poll the ports for port-security data
+     *
+     * @param  mixed  $os
+     * @param  mixed  $device
+     * @return Collection<PortSecurity>
+     */
+    public function pollPortSecurity($os, $device): Collection;
+}

LibreNMS/Modules/PortSecurity.php

@@ -0,0 +1,107 @@
+<?php
+
+/*
+ * PortSecurity.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2023 Michael Adams
+ * @author     Michael Adams <[email protected]>
+ */
+
+namespace LibreNMS\Modules;
+
+use App\Models\Device;
+use App\Observers\ModuleModelObserver;
+use LibreNMS\DB\SyncsModels;
+use LibreNMS\Interfaces\Data\DataStorageInterface;
+use LibreNMS\Interfaces\Discovery\PortSecurityDiscovery;
+use LibreNMS\Interfaces\Module;
+use LibreNMS\Interfaces\Polling\PortSecurityPolling;
+use LibreNMS\OS;
+use LibreNMS\Polling\ModuleStatus;
+
+class PortSecurity implements Module
+{
+    use SyncsModels;
+
+    /**
+     * @inheritDoc
+     */
+    public function dependencies(): array
+    {
+        return [];
+    }
+
+    public function shouldDiscover(OS $os, ModuleStatus $status): bool
+    {
+        return $status->isEnabledAndDeviceUp($os->getDevice()) && $os instanceof PortSecurityDiscovery;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function discover(OS $os): void
+    {
+        $this->poll($os, app('Datastore'));
+    }
+
+    public function shouldPoll(OS $os, ModuleStatus $status): bool
+    {
+        return $status->isEnabledAndDeviceUp($os->getDevice()) && $os instanceof PortSecurityPolling;
+    }
+
+    /**
+     * Poll data for this module and update the DB
+     *
+     * @param  \LibreNMS\OS  $os
+     */
+    public function poll(OS $os, DataStorageInterface $datastore): void
+    {
+        if ($os instanceof PortSecurityPolling) {
+            $device = $os->getDevice();
+            $portsec = $os->pollPortSecurity($os, $device);
+            ModuleModelObserver::observe(\App\Models\PortSecurity::class);
+            $this->syncModels($device, 'portSecurity', $portsec);
+        }
+    }
+
+    public function dataExists(Device $device): bool
+    {
+        return $device->portSecurity()->exists();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function cleanup(Device $device): int
+    {
+        return $device->portSecurity()->delete();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function dump(Device $device, string $type): ?array
+    {
+        return [
+            'PortSecurity' => $device->portSecurity()->orderBy('port_id')
+                ->get()->map->makeHidden(['id', 'device_id']),
+        ];
+    }
+}

LibreNMS/OS/Ios.php

@@ -34,8 +34,10 @@
 use LibreNMS\Interfaces\Discovery\Sensors\WirelessRsrqDiscovery;
 use LibreNMS\Interfaces\Discovery\Sensors\WirelessRssiDiscovery;
 use LibreNMS\Interfaces\Discovery\Sensors\WirelessSnrDiscovery;
+use LibreNMS\Interfaces\Polling\PortSecurityPolling;
 use LibreNMS\OS\Shared\Cisco;
 use LibreNMS\OS\Traits\CiscoCellular;
+use LibreNMS\OS\Traits\CiscoPortSecurity;
 
 class Ios extends Cisco implements
     WirelessCellDiscovery,
@@ -44,9 +46,11 @@ class Ios extends Cisco implements
     WirelessRssiDiscovery,
     WirelessRsrqDiscovery,
     WirelessRsrpDiscovery,
-    WirelessSnrDiscovery
+    WirelessSnrDiscovery,
+    PortSecurityPolling
 {
     use CiscoCellular;
+    use CiscoPortSecurity;
 
     /**
      * @return WirelessSensor[] Sensors

LibreNMS/OS/Iosxe.php

@@ -43,6 +43,7 @@
 use LibreNMS\Interfaces\Polling\IsIsPolling;
 use LibreNMS\Interfaces\Polling\OSPolling;
 use LibreNMS\OS\Traits\CiscoCellular;
+use LibreNMS\OS\Traits\CiscoPortSecurity;
 use LibreNMS\Util\IP;
 use SnmpQuery;
 
@@ -59,6 +60,7 @@ class Iosxe extends Ciscowlc implements
 {
     use SyncsModels;
     use CiscoCellular;
+    use CiscoPortSecurity;
 
     /**
      * Array of shortened ISIS codes