config.js

Go to the documentation of this file.

/**
 * @file routes/config.js
 * @module routes/config
 * @description RMM agent configuration API. Provides centralized configuration endpoint that
 * agents query to retrieve policy settings, enabled plugins, and tenant contract details.
 * Used by agents during initialization and periodic configuration refresh.
 * 
 * **Configuration Components:**
 * - Policy: Heartbeat interval, logging level, monitoring thresholds
 * - Plugins: List of enabled plugins for this agent
 * - Contract: Tenant's service contract details and limits
 * 
 * **Agent Configuration Workflow:**
 * 1. Agent startup/initialization
 * 2. Query GET /config/{agentId}
 * 3. Receive policy, plugins, contract settings
 * 4. Apply configuration locally
 * 5. Periodic refresh (e.g., every 1 hour)
 * 
 * **Security:**
 * No authentication required (public endpoint for agent communication).
 * Agent identity validated via agentId lookup. Returns 404 if agent not found.
 * 
 * **Related Models:**
 * - agents table (agent_id, policy_id, tenant_id)
 * - policies table (heartbeat, logging)
 * - plugins table (plugin permissions per agent)
 * - contracts table (service limits and billing)
 * @requires express
 * @requires ../models/Agent
 * @requires ../models/Policies
 * @requires ../models/Plugins
 * @requires ../models/Contracts
 * @author IBG MSP Development Team
 * @date 2024-03-11
 * @since 1.0.0
 * @see {@link module:routes/agent} for agent registration and management
 * @see {@link module:routes/plugins} for plugin management
 */
 
const express = require("express");
const router = express.Router();
 
const Agents = require("../models/Agent");
const Policies = require("../models/Policies");
const Plugins = require("../models/Plugins");
const Contracts = require("../models/Contracts");
 
/**
 * @api {get} /config/:agentId Get Agent Configuration
 * @apiName GetAgentConfig
 * @apiGroup Agent Configuration
 * @apiDescription Retrieves complete configuration for an RMM agent including policy settings,
 * enabled plugins, and tenant contract details. Called by agents during initialization and
 * periodic refresh cycles. Public endpoint (no authentication) for agent communication.
 * 
 * **Configuration Returned:**
 * - heartbeat: Heartbeat interval in seconds (how often agent should report status)
 * - logging: Logging level (debug, info, warning, error)
 * - plugins: Array of enabled plugin configurations for this agent
 * - contracts: Tenant's service contract with resource limits and billing info
 * 
 * **Agent Initialization Flow:**
 * 1. Agent installed on device
 * 2. Agent queries /config/{agentId} on first startup
 * 3. Agent applies settings (heartbeat, logging, plugins)
 * 4. Agent starts normal operation with these settings
 * 5. Periodically re-queries for configuration updates
 * 
 * **Policy Settings:**
 * - heartbeat: Seconds between heartbeat transmissions (default: 300 = 5 minutes)
 * - logging: Level of detail for agent logs sent to platform
 * 
 * **Plugin Configuration:**
 * Array of plugin objects with:
 * - plugin_id: Unique plugin identifier
 * - enabled: Whether plugin is active
 * - config: Plugin-specific configuration JSON
 * 
 * **Contract Information:**
 * Tenant's service contract including:
 * - contract_id: Contract identifier
 * - max_devices: Maximum allowed devices
 * - billing_frequency: Monthly, quarterly, annually
 * - resource_limits: CPU/memory/disk monitoring thresholds
 * 
 * **Error Handling:**
 * Returns 404 if agent not found (invalid agentId or deleted agent).
 * Returns 500 for database/model errors.
 * @apiParam {string} agentId Agent UUID or ID (in URL path)
 * @apiSuccess {number} heartbeat Heartbeat interval in seconds
 * @apiSuccess {string} logging Logging level (debug, info, warning, error)
 * @apiSuccess {object[]} plugins Array of enabled plugin configurations
 * @apiSuccess {object} contracts Tenant's service contract details
 * @apiError {number} 404 Agent not found (invalid agentId)
 * @apiError {number} 500 Configuration error (database/model failure)
 * @apiExample {curl} Example Request:
 *   curl -X GET \
 *        "https://api.everydaytech.au/config/550e8400-e29b-41d4-a716-446655440000"
 * @apiExample {json} Success Response:
 *   HTTP/1.1 200 OK
 *   {
 *     "heartbeat": 300,
 *     "logging": "info",
 *     "plugins": [
 *       {
 *         "plugin_id": "monitoring",
 *         "enabled": true,
 *         "config": {"cpu_threshold": 90, "memory_threshold": 85}
 *       },
 *       {
 *         "plugin_id": "patching",
 *         "enabled": true,
 *         "config": {"auto_install": false, "reboot_allowed": false}
 *       }
 *     ],
 *     "contracts": {
 *       "contract_id": 42,
 *       "max_devices": 500,
 *       "billing_frequency": "monthly",
 *       "resource_limits": {"cpu": 90, "memory": 85, "disk": 90}
 *     }
 *   }
 * @since 1.0.0
 * @see {@link module:routes/agent} for agent registration
 * @see {@link module:models/Policies} for policy management
 */
router.get("/config/:agentId", async (req, res) => {
  try {
    const agent = await Agents.getAgent(req.params.agentId);
    if (!agent) return res.status(404).json({ error: "Agent not found" });
    const policy = await Policies.getPolicy(agent.policy_id);
    const plugins = await Plugins.getAllowedPlugins(agent.agent_id);
    const contract = await Contracts.getContractForTenant(agent.tenant_id);
 
    res.json({
      heartbeat: policy.heartbeat,
      logging: policy.logging,
      plugins,
      contracts: contract
    });
 
  } catch (err) {
    res.status(500).json({ error: "CONFIG_ERROR" });
  }
});
 
module.exports = router;