deviceDiscovery.js

Go to the documentation of this file.

/**
 * @file deviceDiscovery.js
 * @module routes/deviceDiscovery
 * @description Network device discovery endpoint for agent scanner plugin.
 * Receives network scan results (SNMP, ARP, etc.) from agents and stores in Redis/database.
 * Enables automatic device inventory and network mapping.
 * @requires express
 * @requires middleware/auth
 * @requires services/db
 * @requires ioredis
 * @author RMM-PSA Development Team
 * @copyright 2026 RMM-PSA Platform
 * @license Proprietary
 */
 
/**
 * @apiDefine DeviceDiscovery Network Device Discovery
 * Network scanner results from agent plugins
 */
 
const express = require('express');
const router = express.Router();
const authenticateToken = require('../middleware/auth');
const pool = require('../services/db');
 
/**
 * @api {post} /api/device-discovery Submit discovered devices
 * @apiName SubmitDeviceDiscovery
 * @apiGroup DeviceDiscovery
 * @apiDescription Agent network scanner plugin submits discovered devices (SNMP/ARP scan results).
 * Data stored in Redis queue for processing. SNMP devices with sysDescr auto-inserted into database.
 * Supports network topology mapping and automatic device inventory.
 * @apiParam {string} agent_uuid Agent UUID performing scan
 * @apiParam {string} [type="network"] Discovery type ("network", "snmp")
 * @apiParam {object[]} data Array of discovered devices
 * @apiParam {string} data.ip Device IP address
 * @apiParam {string} [data.mac] Device MAC address
 * @apiParam {string} [data.sysDescr] SNMP system description (sysDescr OID)
 * @apiParam {string} [data.sysName] SNMP system name (sysName OID)
 * @apiParam {string} [data.sysLocation] SNMP system location (sysLocation OID)
 * @apiParam {DateTime} [ts] Discovery timestamp (default: now)
 * @apiSuccess {string} status="ok" Success status
 * @apiSuccess {number} devices Number of devices received
 * @apiSuccess {number} dbAdded Number of devices auto-inserted to database (SNMP only)
 * @apiError (400) {String} error="Missing agent_uuid or device data" Required parameters missing
 * @apiError (500) {String} error="Failed to save device data" Redis or database error
 * @apiExample {curl} Example (SNMP scan):
 *   curl -X POST http://localhost:3000/api/device-discovery \\\\
 *     -H "Authorization: Bearer YOUR_TOKEN" \\\\
 *     -H "Content-Type: application/json" \\\\
 *     -d '{
 *       "agent_uuid": "abc-123-uuid",
 *       "type": "snmp",
 *       "ts": "2026-03-12T10:00:00.000Z",
 *       "data": [
 *         {
 *           "ip": "192.168.1.1",
 *           "mac": "00:11:22:33:44:55",
 *           "sysDescr": "Cisco IOS Software",
 *           "sysName": "CORE-SWITCH-01",
 *           "sysLocation": "Server Room"
 *         }
 *       ]
 *     }'
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "status": "ok",
 *     "devices": 1,
 *     "dbAdded": 1
 *   }
 */
router.post('/', authenticateToken, async (req, res) => {
  try {
    const { agent_uuid, type, data, ts } = req.body;
    if (!agent_uuid || !Array.isArray(data)) {
      return res.status(400).json({ error: 'Missing agent_uuid or device data' });
    }
    // Use Redis for storing detected endpoints for later processing
    const Redis = require('ioredis');
    const redisConfig = require('../config/redis');
    const redis = new Redis(redisConfig);
    const key = `deviceDiscovery:${agent_uuid}`;
    let dbAdded = 0;
    for (const device of data) {
      await redis.rpush(key, JSON.stringify({
        ip: device.ip,
        mac: device.mac,
        type: type || 'network',
        discovered_at: ts || new Date().toISOString(),
        sysDescr: device.sysDescr || '',
        sysName: device.sysName || '',
        sysLocation: device.sysLocation || '',
        discovered_by: agent_uuid
      }));
      // If SNMP fingerprint present, auto-add to DB
      if (type === 'snmp' && device.sysDescr) {
        try {
          await pool.query(
            `INSERT INTO devices (ip, mac, sys_descr, sys_name, sys_location, discovered_by, discovered_at)
             VALUES ($1, $2, $3, $4, $5, $6, $7)
             ON CONFLICT (ip, mac) DO UPDATE SET sys_descr = $3, sys_name = $4, sys_location = $5, discovered_by = $6, discovered_at = $7`,
            [device.ip, device.mac, device.sysDescr, device.sysName, device.sysLocation, agent_uuid, ts || new Date().toISOString()]
          );
          dbAdded++;
        } catch (e) {
          console.error('[DeviceDiscovery] DB insert error:', e);
        }
      }
    }
    await redis.expire(key, 86400);
    res.json({ status: 'ok', devices: data.length, dbAdded });
  } catch (err) {
    console.error('[DeviceDiscovery] Error:', err);
    res.status(500).json({ error: 'Failed to save device data' });
  }
});
 
module.exports = router;