agentUpdate.js

Go to the documentation of this file.

/**
 * @file agentUpdate.js
 * @module routes/agentUpdate
 * @description Agent update and distribution endpoints for binary management and plugin delivery.
 * Handles agent binary downloads, hash verification, cleanup of old versions, and plugin distribution.
 * @requires express
 * @requires middleware/auth
 * @requires path
 * @requires fs
 * @requires crypto
 * @author RMM-PSA Development Team
 * @copyright 2026 RMM-PSA Platform
 * @license Proprietary
 */
 
/**
 * @apiDefine AgentUpdate Agent Updates
 * Agent binary distribution and version management
 */
 
const express = require("express");
const authenticateToken = require('../middleware/auth');
const router = express.Router();
const path = require("path");
const fs = require("fs");
 
 
/**
 * @api {post} /api/agent/cleanup-binaries Cleanup old binaries
 * @apiName CleanupAgentBinaries
 * @apiGroup AgentUpdate
 * @apiDescription Remove old agent binary versions, retain only latest N versions (default: 3).
 * Targets files matching pattern: EverydayTechAgent-win-x64-*.exe. Returns deleted and kept files.
 * @apiParam {number} [keepCount=3] Number of latest versions to retain
 * @apiSuccess {string[]} deleted Array of deleted filenames
 * @apiSuccess {string[]} kept Array of retained filenames
 * @apiExample {curl} Example:
 *   curl -X POST http://localhost:3000/api/agent/cleanup-binaries \\
 *     -H "Authorization: Bearer YOUR_TOKEN" \\
 *     -H "Content-Type: application/json" \\
 *     -d '{"keepCount": 5}'
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "deleted": [
 *       "EverydayTechAgent-win-x64-2026.02.15.1200.exe",
 *       "EverydayTechAgent-win-x64-2026.02.10.0900.exe"
 *     ],
 *     "kept": [
 *       "EverydayTechAgent-win-x64-2026.03.12.1400.exe",
 *       "EverydayTechAgent-win-x64-2026.03.10.1000.exe",
 *       "EverydayTechAgent-win-x64-2026.03.01.0800.exe"
 *     ]
 *   }
 */
router.post('/cleanup-binaries', authenticateToken, (req, res) => {
  const base = path.resolve('/opt/apps/IBG_HUB_dist/agent');
  const keepCount = parseInt(req.body.keepCount, 10) || 3;
  const files = fs.readdirSync(base).filter(f => f.startsWith('EverydayTechAgent-win-x64-') && f.endsWith('.exe'));
  // Sort by version/date in filename (assuming format EverydayTechAgent-win-x64-YYYY.MM.DD.HHMM.exe)
  files.sort((a, b) => b.localeCompare(a)); // descending
  const toDelete = files.slice(keepCount);
  let deleted = [];
  for (const file of toDelete) {
    try {
      fs.unlinkSync(path.join(base, file));
      deleted.push(file);
    } catch (err) {
      console.error(`[Cleanup] Failed to delete ${file}:`, err.message);
    }
  }
  res.json({ deleted, kept: files.slice(0, keepCount) });
});
 
/**
 * @api {get} /api/agent/hash/:version Get agent binary hash
 * @apiName GetAgentHash
 * @apiGroup AgentUpdate
 * @apiDescription Retrieve SHA-256 hash for specified agent version. Checks manifest first,
 * then calculates hash from binary file. Returns plain text hash string.
 * Used by agents to verify downloaded binaries for integrity and security.
 * @apiParam {string} version Agent version (e.g., "1.0.12" or "2026.03.12.1400")
 * @apiSuccess {string} hash SHA-256 hash (64 hex characters, plain text response)
 * @apiError (404) {String} error="Agent hash not found" Version not found in manifest or filesystem
 * @apiError (500) {String} error="Failed to read manifest" Manifest parsing error
 * @apiExample {curl} Example:
 *   curl -X GET http://localhost:3000/api/agent/hash/1.0.12 \\
 *     -H "Authorization: Bearer YOUR_TOKEN"
 * @apiSuccessExample {text} Success-Response:
 *   HTTP/1.1 200 OK
 *   Content-Type: text/plain
 *   
 *   a3f2c1b5d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5
 */
router.get('/hash/:version', authenticateToken, (req, res) => {
  const version = req.params.version;
  // Try to get hash from manifest
  const manifestPath = path.resolve('/opt/apps/IBG_HUB_dist/agent/plugin-manifest.json');
  let hash = null;
  if (fs.existsSync(manifestPath)) {
    try {
      const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
      if (manifest.agentVersion === version && manifest.agentHash) {
        hash = manifest.agentHash;
      } else if (manifest.plugins && Array.isArray(manifest.plugins)) {
        // Try to find agent binary in plugins list
        const agentPlugin = manifest.plugins.find(p => p.name && p.name.includes('EverydayTechAgent') && p.hash);
        if (agentPlugin) hash = agentPlugin.hash;
      }
    } catch (err) {
      return res.status(500).json({ error: 'Failed to read manifest' });
    }
  }
  // If not found in manifest, calculate hash from file
  if (!hash) {
    const base = path.resolve('/opt/apps/IBG_HUB_dist/agent');
    const winBin = path.join(base, `EverydayTechAgent-win-x64-${version}.exe`);
    const genericBin = path.join(base, `EverydayTechAgent-${version}.exe`);
    const fallbackBin = path.join(base, `EverydayTechAgent-win-x64.exe`);
    let file = null;
    if (fs.existsSync(winBin)) file = winBin;
    else if (fs.existsSync(genericBin)) file = genericBin;
    else if (fs.existsSync(fallbackBin)) file = fallbackBin;
    if (file && fs.existsSync(file)) {
      const crypto = require('crypto');
      const data = fs.readFileSync(file);
      hash = crypto.createHash('sha256').update(data).digest('hex');
    }
  }
  if (!hash) return res.status(404).json({ error: 'Agent hash not found' });
  return res.send(hash);
});
 
/**
 * @api {get} /api/agent/download/:version Download agent binary
 * @apiName DownloadAgentBinary
 * @apiGroup AgentUpdate
 * @apiDescription Download agent binary for specified version. Tries multiple filename patterns:
 * EverydayTechAgent-win-x64-{version}.exe, EverydayTechAgent-{version}.exe, fallback to latest.
 * After download, publishes Redis cleanup job to remove old binaries.
 * @apiParam {string} version Agent version (e.g., "1.0.12" or "2026.03.12.1400")
 * @apiSuccess {File} file Binary executable file download
 * @apiError (404) {String} error="Agent binary not found" No matching binary file found
 * @apiExample {curl} Example:
 *   curl -X GET http://localhost:3000/api/agent/download/1.0.12 \\
 *     -H "Authorization: Bearer YOUR_TOKEN" \\
 *     -o EverydayTechAgent.exe
 * @apiSuccessExample {binary} Success-Response:
 *   HTTP/1.1 200 OK
 *   Content-Type: application/octet-stream
 *   Content-Disposition: attachment; filename="EverydayTechAgent-win-x64-1.0.12.exe"
 *   
 *   [binary executable content]
 */
router.get('/download/:version', authenticateToken, (req, res) => {
  const version = req.params.version;
  // Map version to expected binary filename
  // Example: EverydayTechAgent-win-x64.exe for windows
  // You may want to adjust this logic if you support multiple OSes
  const base = path.resolve('/opt/apps/IBG_HUB_dist/agent');
  // Try windows binary first (customize as needed)
  const winBin = path.join(base, `EverydayTechAgent-win-x64-${version}.exe`);
  const genericBin = path.join(base, `EverydayTechAgent-${version}.exe`);
  const fallbackBin = path.join(base, `EverydayTechAgent-win-x64.exe`); // fallback to latest
  let file = null;
  if (fs.existsSync(winBin)) file = winBin;
  else if (fs.existsSync(genericBin)) file = genericBin;
  else if (fs.existsSync(fallbackBin)) file = fallbackBin;
  if (!file) return res.status(404).send('Agent binary not found');
  return res.download(file);
  // After serving a new binary, publish a Redis job to clean up old binaries
  try {
    const Redis = require('ioredis');
    const redis = new Redis(require('../config/redis'));
    redis.publish('agent-binary-cleanup', JSON.stringify({ action: 'cleanup', keepCount: 3 }));
    redis.quit();
    console.log('[AgentUpdate] Published agent-binary-cleanup job to Redis');
  } catch (err) {
    console.error('[AgentUpdate] Failed to publish cleanup job:', err.message);
  }
});
 
/**
 * Resolve agent binary path by operating system
 * @param os
 * @private
 */
function resolveAgentBinary(os) {
  const base = path.resolve("/opt/apps/IBG_HUB_dist/agent");
 
  const map = {
    windows: "EverydayTechAgent-win-x64.exe",
    linux: "EverydayTechAgent-linux-x64",
    mac: "EverydayTechAgent-macos-x64"
  };
 
  const file = path.join(base, map[os]);
  return fs.existsSync(file) ? file : null;
}
 
/**
 * @api {get} /api/agent/update/download Download agent by OS
 * @apiName DownloadAgentByOS
 * @apiGroup AgentUpdate
 * @apiDescription Download latest agent binary for specified operating system.
 * Supports windows, linux, mac. Returns platform-specific binary.
 * @apiParam {string} os Operating system ("windows", "linux", "mac") - query parameter
 * @apiSuccess {File} file Binary executable file download for specified OS
 * @apiError (400) {String} error="missing_os" OS parameter not provided
 * @apiError (404) {String} error="not_found" No binary available for specified OS
 * @apiExample {curl} Example (Windows):
 *   curl -X GET "http://localhost:3000/api/agent/update/download?os=windows" \\
 *     -H "Authorization: Bearer YOUR_TOKEN" \\
 *     -o EverydayTechAgent.exe
 * @apiSuccessExample {binary} Success-Response:
 *   HTTP/1.1 200 OK
 *   Content-Type: application/octet-stream
 *   Content-Disposition: attachment; filename="EverydayTechAgent-win-x64.exe"
 *   
 *   [binary executable content]
 */
router.get("/update/download", authenticateToken, (req, res) => {
  const os = req.query.os;
  if (!os) return res.status(400).json({ error: "missing_os" });
 
  const file = resolveAgentBinary(os);
  if (!file) return res.status(404).json({ error: "not_found" });
 
  return res.download(file);
});
 
/**
 * @api {get} /api/agent/:agent_uuid/plugins List agent plugins
 * @apiName ListAgentPlugins
 * @apiGroup AgentUpdate
 * @apiDescription Retrieve available plugins for agent. Returns base64-encoded plugin binaries
 * from plugins directory (.exe, .sh, .pkg files). Used by agents to sync plugin catalog.
 * @apiParam {string} agent_uuid Agent UUID (path parameter, currently unused for filtering)
 * @apiSuccess {object[]} plugins Array of plugin objects
 * @apiSuccess {string} plugins.name Plugin filename (e.g., "rustdesk-installer.exe")
 * @apiSuccess {string} plugins.binary Base64-encoded plugin binary data
 * @apiError (404) {String} error="Plugins directory not found" Plugin directory missing
 * @apiExample {curl} Example:
 *   curl -X GET http://localhost:3000/api/agent/abc-123-uuid/plugins \\
 *     -H "Authorization: Bearer YOUR_TOKEN"
 * @apiSuccessExample {json} Success-Response:
 *   HTTP/1.1 200 OK
 *   [
 *     {
 *       "name": "rustdesk-installer.exe",
 *       "binary": "TVqQAAMAAAAEAAAA//8AALgAAAAA..."
 *     },
 *     {
 *       "name": "network-scanner.sh",
 *       "binary": "IyEvYmluL2Jhc2gKZWNobyAiU2Nhbm5pbmcu..."
 *     }
 *   ]
 */
router.get('/:agent_uuid/plugins', authenticateToken, (req, res) => {
  const agent_uuid = req.params.agent_uuid;
  // For now, serve all plugins in the plugins directory
  // Optionally, filter by agent_uuid if needed
  const pluginsDir = path.resolve('/opt/apps/IBG_HUB_dist/agent/plugins');
  if (!fs.existsSync(pluginsDir)) return res.status(404).json({ error: 'Plugins directory not found' });
  const files = fs.readdirSync(pluginsDir).filter(f => f.endsWith('.exe') || f.endsWith('.sh') || f.endsWith('.pkg'));
  const plugins = files.map(name => {
    const filePath = path.join(pluginsDir, name);
    const binary = fs.readFileSync(filePath).toString('base64');
    return { name, binary };
  });
  res.json(plugins);
});
 
module.exports = router;