commands.js

Go to the documentation of this file.

/**
 * @file commands.js
 * @module CommandsRoutes
 * @description Remote command execution result handler. Receives command execution results from agents via callback endpoint. Used for async command execution where agents report back results after completing commands.
 * @see {@link ../models/Commands} for command model and storage
 * @apiDefine CommandsGroup Commands
 * @apiGroup Commands
 * @apiError (Error 500) ServerError Failed to record command result.
 */
 
const express = require("express");
const router = express.Router();
 
const Commands = require("../models/Commands");
 
// ...existing code...
 
/**
 * @api {post} /commands/result/:cmdId Record command execution result
 * @apiName RecordCommandResult
 * @apiGroup Commands
 * @apiDescription Callback endpoint for agents to report command execution results. Agents POST their command output to this endpoint after executing a command. Updates the command record with output and marks it as complete.
 * @apiParam {string} cmdId Command ID (URL parameter).
 * @apiParam {string} output Command execution output (stdout/stderr).
 * @apiSuccess {boolean} success Operation success status (always true).
 * @apiExample {curl} Example usage:
 *     curl -X POST -d '{"output":"Command completed successfully"}' https://api.example.com/commands/result/cmd-123
 * @apiExample {json} Response example:
 *     {
 *       "success": true
 *     }
 */
router.post("/result/:cmdId", async (req, res) => {
  const { output } = req.body;
 
  await Commands.completeCommand(req.params.cmdId, output, true);
  res.json({ success: true });
});
 
module.exports = router;