Skip to main content

Getting Started, Roles & Plan Tiers

This guide walks security operators and SOC analysts through authenticating to VulnerGuard, understanding organization roles and plan quotas, and executing your first full-spectrum assessment.

1. Accessing the Platform​

Navigate to https://vulnerguard.com/login to authenticate or https://vulnerguard.com/register to provision a new operator account.

Authentication & Session Lifecycle​

  • JWT Token Issuance: Successful authentication at POST /api/auth/login issues a signed bearer token (Authorization: Bearer <token>) valid for 24 hours.
  • Automatic Organization Provisioning: When a user registers or logs in for the first time, VulnerGuard automatically provisions a dedicated multi-tenant Organization (Org), assigns the user the owner role inside OrgMember, and initializes monthly usage counters (OrgUsageMonthly).
  • Demo Sandbox Mode: For rapid evaluation without modifying production data, click Launch Live Sandbox on the login screen (POST /api/auth/demo) when sandbox mode is enabled.

2. Role-Based Access Control (RBAC)​

VulnerGuard enforces strict RBAC at both the platform level (User.role) and the multi-tenant organization level (OrgMember.role):

RoleScopeCapabilities
admin / ownerPlatform & OrganizationFull access to /admin, encrypted Secret Vault, User/Org management, JIT tool elevation approvals, SOC broker configuration, and all 14 security tools.
analyst / memberOrganizationCan launch automated scans (/scanner), view real-time telemetry, triage findings, interact with the SOC Console (/soc) and Pentest Workspace (/pentestws), and request JIT access for restricted exploit frameworks.
viewerOrganizationRead-only access to Command Center dashboards, completed scan reports, and vulnerability analytics.

3. Subscription Tiers & Monthly Quotas​

Every organization is governed by a subscription plan (free, pro, or enterprise) tracked automatically in real time by OrgUsageMonthly:

Capability / QuotaFree TierPro TierEnterprise Tier
Monthly Scans (scans_per_month)25 scans / mo250 scans / moUnlimited (10,000+)
Direct Tool Executions (tool_runs_per_month)100 runs / mo1,500 runs / moUnlimited
AI Report Generations (reports_per_month)25 reports / mo250 reports / moUnlimited
Recon & Discovery Engines (nmap, subfinder, katana, testssl)✅ Included✅ Included✅ Included
Web & Vulnerability Scanners (nuclei, zap, wpscan, ffuf, trivy, gitleaks)✅ Included✅ Included✅ Included
Exploitation & Red-Team Arsenal (sqlmap, metasploit, beef, set)🔒 Restricted✅ Included (with Approval Gate)✅ Included + Custom Profiles
SOC / SOAR Broker (TheHive, Cortex, MISP, Shuffle)Read-OnlyFull Case & Analyzer DispatchCustom Webhooks & Multi-Org
Checking Your Current Quota

You can inspect your organization's active plan, features, and remaining monthly scan counters at any time in the Command Center (/dashboard) or via GET /api/org/current.

4. Launching Your First Multi-Engine Scan​

  1. Open the 14-Tool Scanner: Navigate to https://vulnerguard.com/scanner.
  2. Enter Authorized Target URI or Hostname:
    • For web and full-stack assessments, provide the full HTTPS URL (e.g., https://target.example.com).
    • Our target parser automatically extracts the root hostname (target.example.com) for DNS/TCP tools (Nmap, Subfinder, TestSSL.sh) while preserving the full URL scheme for HTTP engines (Nuclei, Katana, FFUF, OWASP ZAP, WPScan).
  3. Select Scan Mode & Engine Arsenal:
    • Automated AI Orchestration (Automated): Select the engines you want in scope (e.g., nmap, subfinder, katana, testssl, nuclei, ffuf, gitleaks). SecurityAgent sequences them in optimal discovery-to-validation order.
    • Manual Tool Execution: Run individual engines with custom flags or target parameters.
  4. Monitor Real-Time Telemetry:
    • Upon submission (POST /api/scan), VulnerGuard creates a persistent Scan record, initializes a background SecurityAgent worker thread, and joins your browser to the dedicated Socket.IO scan room.
    • Even if you refresh the page or switch tabs mid-scan, the Socket.IO room handler automatically replays the complete log buffer so you never lose a single line of terminal output.
  5. Review Findings & Executive AI Brief:
    • As each tool finishes, parsed vulnerabilities appear immediately in the Findings tab with CVSS severity badges, raw evidence payloads, and remediation guidance.
    • Once all tools complete, the AI reasoning engine synthesizes an executive summary stored directly in the scan report.