Solar Plexus

- New Plugin structure with pluginBase.js - New plugins : Object Detection with YoloV3 and Face Detection with Dlib - Fix 2-Factor Authentication
2025-03-09 15:40:15 +00:00 · 2018-11-17 10:45:40 -08:00 · 2018-11-17 10:45:40 -08:00 · 24de55e45a
commit 24de55e45a
parent e0f7c135af
22 changed files with 1268 additions and 899 deletions
--- a/plugins/yolo/INSTALL.sh
+++ b/plugins/yolo/INSTALL.sh
@ -0,0 +1,106 @@
+#!/bin/bash
+echo "----------------------------------------"
+echo "-- Installing Yolo Plugin for Shinobi --"
+echo "----------------------------------------"
+if ! [ -x "$(command -v nvidia-smi)" ]; then
+    echo "You need to install NVIDIA Drivers to use this."
+    echo "inside the Shinobi directory run the following :"
+    echo "sh INSTALL/cuda.sh"
+    exit 1
+else
+    echo "NVIDIA Drivers found..."
+    echo "$(nvidia-smi |grep 'Driver Version')"
+fi
+echo "-----------------------------------"
+if [ ! -d "/usr/local/cuda" ]; then
+    echo "You need to install CUDA Toolkit to use this."
+    echo "inside the Shinobi directory run the following :"
+    echo "sh INSTALL/cuda.sh"
+    exit 1
+else
+    echo "CUDA Toolkit found..."
+    echo "============="
+    echo "Shinobi - Do you want to install the plugin with CUDA support?"
+    echo "Do this if you installed NVIDIA Drivers, CUDA Toolkit, and CuDNN"
+    echo "(y)es or (N)o"
+    read usecuda
+    if [ "$usecuda" = "y" ] || [ "$usecuda" = "Y" ]; then
+        export PATH=/usr/local/cuda/bin:$PATH
+        export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH
+    fi
+fi
+echo "-----------------------------------"
+if ! [ -x "$(command -v opencv_version)" ]; then
+    echo "You need to install OpenCV with CUDA first."
+    echo "inside the Shinobi directory run the following :"
+    echo "sh INSTALL/opencv-cuda.sh"
+    exit 1
+else
+    echo "OpenCV found... : $(opencv_version)"
+fi
+echo "============="
+echo "Shinobi - Do you want to Install Tiny Weights?"
+echo "This is better for Graphics Cards with less than 4GB RAM"
+echo "(y)es or (N)o"
+weightNameExtension=""
+read tinyweights
+if [ "$tinyweights" = "y" ] || [ "$tinyweights" = "Y" ]; then
+    weightNameExtension="-tiny"
+fi
+echo "-----------------------------------"
+if [ ! -d "models" ]; then
+    echo "Downloading yolov3 weights..."
+    mkdir models
+    wget -O models/yolov3.weights https://pjreddie.com/media/files/yolov3$weightNameExtension.weights
+else
+    echo "yolov3 weights found..."
+fi
+echo "-----------------------------------"
+if [ ! -d "models/cfg" ]; then
+    echo "Downloading yolov3 cfg"
+    mkdir models/cfg
+    wget -O models/cfg/coco.data https://raw.githubusercontent.com/pjreddie/darknet/master/cfg/coco.data
+    wget -O models/cfg/yolov3.cfg https://raw.githubusercontent.com/pjreddie/darknet/master/cfg/yolov3$weightNameExtension.cfg
+else
+    echo "yolov3 cfg found..."
+fi
+echo "-----------------------------------"
+if [ ! -d "models/data" ]; then
+    echo "Downloading yolov3 data"
+    mkdir models/data
+    wget -O models/data/coco.names https://raw.githubusercontent.com/pjreddie/darknet/master/data/coco.names
+else
+    echo "yolov3 data found..."
+fi
+echo "-----------------------------------"
+if [ ! -e "./conf.json" ]; then
+    echo "Creating conf.json"
+    sudo cp conf.sample.json conf.json
+else
+    echo "conf.json already exists..."
+fi
+echo "-----------------------------------"
+if [ -f /etc/redhat-release ]; then
+  yum update
+  yum install imagemagick -y
+fi
+
+if [ -f /etc/lsb-release ]; then
+  apt update -y
+  apt install imagemagick -y
+fi
+echo "-----------------------------------"
+echo "Getting node-gyp to build C++ modules"
+npm install node-gyp -g --unsafe-perm
+echo "-----------------------------------"
+echo "Getting C++ module : node-yolo-shinobi"
+echo "https://www.npmjs.com/package/node-yolo-shinobi is a fork of https://github.com/rcaceiro/node-yolo"
+npm install --unsafe-perm
+npm install node-yolo-shinobi --unsafe-perm
+npm audit fix --force
+echo "-----------------------------------"
+echo "Start the plugin with pm2 like so :"
+echo "pm2 start shinobi-yolo.js"
+echo "-----------------------------------"
+echo "Start the plugin without pm2 :"
+echo "node shinobi-yolo.js"
--- a/plugins/yolo/README.md
+++ b/plugins/yolo/README.md
@ -0,0 +1,70 @@
+# Yolo
+
+**Ubuntu and CentOS only**
+
+Go to the Shinobi directory. **/home/Shinobi** is the default directory.
+
+```
+cd /home/Shinobi/plugins/yolo
+```
+
+Copy the config file.
+
+```
+sh INSTALL.sh
+```
+
+Start the plugin.
+
+```
+pm2 start shinobi-yolo.js
+```
+
+Doing this will reveal options in the monitor configuration. Shinobi does not need to be restarted when a plugin is initiated or stopped.
+
+## Run the plugin as a Host
+> The main app (Shinobi) will be the client and the plugin will be the host. The purpose of allowing this method is so that you can use one plugin for multiple Shinobi instances. Allowing you to easily manage connections without starting multiple processes.
+
+Edit your plugins configuration file. Set the `hostPort` **to be different** than the `listening port for camera.js`.
+
+```
+nano conf.json
+```
+
+Here is a sample of a Host configuration for the plugin.
+ - `plug` is the name of the plugin corresponding in the main configuration file.
+ - `https` choose if you want to use SSL or not. Default is `false`.
+ - `hostPort` can be any available port number. **Don't make this the same port number as Shinobi.** Default is `8082`.
+ - `type` tells the main application (Shinobi) what kind of plugin it is. In this case it is a detector.
+
+```
+{
+  "plug":"Yolo",
+  "hostPort":8082,
+  "key":"Yolo123123",
+  "mode":"host",
+  "type":"detector"
+}
+```
+
+Now modify the **main configuration file** located in the main directory of Shinobi.
+
+```
+nano conf.json
+```
+
+Add the `plugins` array if you don't already have it. Add the following *object inside the array*.
+
+```
+  "plugins":[
+      {
+          "id" : "Yolo",
+          "https" : false,
+          "host" : "localhost",
+          "port" : 8082,
+          "key" : "Yolo123123",
+          "mode" : "host",
+          "type" : "detector"
+      }
+  ],
+```
--- a/plugins/yolo/conf.sample.json
+++ b/plugins/yolo/conf.sample.json
@ -0,0 +1,8 @@
+{
+  "plug":"Yolo",
+  "host":"localhost",
+  "port":8080,
+  "key":"Yolo123123",
+  "mode":"client",
+  "type":"detector"
+}
--- a/plugins/yolo/package.json
+++ b/plugins/yolo/package.json
@ -0,0 +1,20 @@
+{
+  "name": "shinobi-yolo",
+  "version": "2.0.0",
+  "description": "YoloV3 plugin for Shinobi that uses C++ functions for detection.",
+  "main": "shinobi-yolo.js",
+  "dependencies": {
+    "socket.io-client": "^1.7.4",
+    "express": "^4.16.2",
+    "moment": "^2.19.2",
+    "socket.io": "^2.0.4",
+    "imagickal": "^4.0.0",
+    "node-yolo-shinobi": "^2.0.3"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Moe Alam",
+  "license": "ISC"
+}
--- a/plugins/yolo/shinobi-yolo.js
+++ b/plugins/yolo/shinobi-yolo.js
@ -0,0 +1,93 @@
+//
+// Shinobi - Yolo Plugin
+// Copyright (C) 2016-2025 Moe Alam, moeiscool
+//
+// # Donate
+//
+// If you like what I am doing here and want me to continue please consider donating :)
+// PayPal : paypal@m03.ca
+//
+// Base Init >>
+var fs = require('fs');
+var config = require('./conf.json')
+var s
+try{
+    s = require('../pluginBase.js')(__dirname,config)
+}catch(err){
+    console.log(err)
+    try{
+        s = require('./pluginBase.js')(__dirname,config)
+    }catch(err){
+        console.log(err)
+        return console.log(config.plug,'Plugin start has failed. pluginBase.js was not found.')
+    }
+}
+// Base Init />>
+var yolo = require('node-yolo-shinobi');//this is @vapi/node-yolo@1.2.4 without the console output for detection speed
+// var yolo = require('@vapi/node-yolo');
+var detector = new yolo(__dirname + "/models", "cfg/coco.data", "cfg/yolov3.cfg", "yolov3.weights");
+s.detectObject=function(buffer,d,tx,frameLocation){
+    var detectStuff = function(frame,callback){
+        detector.detect(frame)
+             .then(detections => {
+                 matrices = []
+                 detections.forEach(function(v){
+                     matrices.push({
+                       x:v.box.x,
+                       y:v.box.y,
+                       width:v.box.w,
+                       height:v.box.h,
+                       tag:v.className,
+                       confidence:v.probability,
+                     })
+                 })
+                 if(matrices.length > 0){
+                     tx({
+                         f:'trigger',
+                         id:d.id,
+                         ke:d.ke,
+                         details:{
+                             plug:config.plug,
+                             name:'yolo',
+                             reason:'object',
+                             matrices:matrices,
+                             imgHeight:parseFloat(d.mon.detector_scale_y),
+                             imgWidth:parseFloat(d.mon.detector_scale_x)
+                         }
+                     })
+                 }
+                 fs.unlink(frame,function(){
+
+                 })
+             })
+             .catch(error => {
+                 console.log(error)
+
+               // here you can handle the errors. Ex: Out of memory
+           })
+    }
+    if(frameLocation){
+        detectStuff(frameLocation)
+    }else{
+        d.tmpFile=s.gid(5)+'.jpg'
+        if(!fs.existsSync(s.dir.streams)){
+            fs.mkdirSync(s.dir.streams);
+        }
+        d.dir=s.dir.streams+d.ke+'/'
+        if(!fs.existsSync(d.dir)){
+            fs.mkdirSync(d.dir);
+        }
+        d.dir=s.dir.streams+d.ke+'/'+d.id+'/'
+        if(!fs.existsSync(d.dir)){
+            fs.mkdirSync(d.dir);
+        }
+        fs.writeFile(d.dir+d.tmpFile,buffer,function(err){
+            if(err) return s.systemLog(err);
+            try{
+                detectStuff(d.dir+d.tmpFile)
+            }catch(error){
+                console.error('Catch: ' + error);
+            }
+        })
+    }
+}