Add Signal CLI transport support (#12954)

* Add Signal CLI support * Update Signal.php * fix style * fix style * fix CI style * fix CI style * escapeshellarg * fix style * fix style * fix style
2024-10-07 16:52:45 +00:00 · 2021-06-18 00:38:09 +02:00
parent 0f429e3d9a
commit d0d8a9024b
2 changed files with 94 additions and 0 deletions
--- a/LibreNMS/Alert/Transport/Signal.php
+++ b/LibreNMS/Alert/Transport/Signal.php
@@ -0,0 +1,80 @@
+<?php
+/* 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/>. */
+
+/**
+ * Signal Transport
+ * @author kzink <kevin.zink@mpi-hd.mpg.de>
+ * @copyright 2021 kzink, LibreNMS
+ * @license GPL
+ */
+
+namespace LibreNMS\Alert\Transport;
+
+use LibreNMS\Alert\Transport;
+
+class Signal extends Transport
+{
+    public function deliverAlert($obj, $opts)
+    {
+        $signalOpts = [
+            'path'  => escapeshellarg($this->config['path']),
+            'recipient-type'  => ($this->config['recipient-type'] == 'group') ? ' -g ' : ' ',
+            'recipient' => escapeshellarg($this->config['recipient']),
+        ];
+
+        return $this->contactSignal($obj, $signalOpts);
+    }
+
+    public function contactSignal($obj, $opts)
+    {
+        exec($opts['path']
+           . ' --dbus-system send'
+           . $opts['recipient-type']
+           . $opts['recipient']
+           . ' -m ' . escapeshellarg($obj['title']));
+
+        return true;
+    }
+
+    public static function configTemplate()
+    {
+        return [
+            'validation' => [],
+            'config' => [
+                [
+                    'title' => 'Path',
+                    'name' => 'path',
+                    'descr' => 'Local Path to CLI',
+                    'type' => 'text',
+                ],
+                [
+                    'title' => 'Recipient type',
+                    'name' => 'recipient-type',
+                    'descr' => 'Phonenumber ',
+                    'type' => 'select',
+                    'options' => [
+                        'Mobile number' => 'single',
+                        'Group' => 'group',
+                    ],
+                ],
+                [
+                    'title' => 'Recipient',
+                    'name' => 'recipient',
+                    'descr' => 'Message recipient',
+                    'type' => 'text',
+                ],
+            ],
+        ];
+    }
+}
--- a/doc/Alerting/Transports.md
+++ b/doc/Alerting/Transports.md
@@ -842,6 +842,20 @@ connect to servicedesk
 | Kayako API Secret | Y2NhZDIxNDMtNjVkMi0wYzE0LWExYTUtZGUwMjJiZDI0ZWEzMmRhOGNiYWMtNTU2YS0yODk0LTA1MTEtN2VhN2YzYzgzZjk5 |
 | Kayako Department | 1 |

+## Signal CLI
+
+Use the Signal Mesenger for Alerts. Run the Signal CLI with the D-Bus option.
+
+[GitHub Project](https://github.com/AsamK/signal-cli)
+
+**Example:**
+
+| Config | Example |
+| ------ | ------- |
+| Path | /opt/signal-cli/bin/signal-cli |
+| Recipient type | Group |
+| Recipient | dfgjsdkgljior4345== |
+
 ## SMSFeedback

 SMSFeedback is a SAAS service, which can be used to deliver Alerts via API, using API url, Username & Password.