mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-08-15 07:50:20 +02:00
The comment claimed analysis-only findings carry no severity. Since v2.2.0 (#413) severity is recorded in both modes, so the technical justification no longer holds. Record the actual remaining reason: an analysis severity is assessed, not measured. Comment only, no behavior change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1320 lines
49 KiB
TypeScript
1320 lines
49 KiB
TypeScript
// Copyright (C) 2025 Keygraph, Inc.
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License version 3
|
|
// as published by the Free Software Foundation.
|
|
|
|
/**
|
|
* Temporal activities for Shannon agent execution.
|
|
*
|
|
* Each activity wraps service calls with Temporal-specific concerns:
|
|
* - Heartbeat loop (2s interval) to signal worker liveness
|
|
* - Error classification into ApplicationFailure
|
|
* - Container lifecycle management
|
|
*
|
|
* Business logic is delegated to services in src/services/.
|
|
*/
|
|
|
|
import fs from 'node:fs/promises';
|
|
import path from 'node:path';
|
|
import { ApplicationFailure, Context, heartbeat } from '@temporalio/activity';
|
|
import { syncPermissionSystemConfig } from '../ai/pi/permission-system.js';
|
|
import { writePlaywrightStealthConfig } from '../ai/playwright-config-writer.js';
|
|
import { AuditSession } from '../audit/index.js';
|
|
import type { ResumeAttempt } from '../audit/metrics-tracker.js';
|
|
import { authStateFile, generateAuditPath, generateSessionJsonPath, type SessionMetadata } from '../audit/utils.js';
|
|
import type { WorkflowSummary } from '../audit/workflow-logger.js';
|
|
import type { CheckpointContext } from '../interfaces/checkpoint-provider.js';
|
|
import {
|
|
ASSEMBLED_REPORT_FILENAME,
|
|
ASSEMBLED_REPORT_PDF_FILENAME,
|
|
DEFAULT_DELIVERABLES_SUBDIR,
|
|
deliverablesDir,
|
|
REPORT_JSON_FILENAME,
|
|
resolveSessionJsonPath,
|
|
SARIF_FILENAME,
|
|
TYPST_TEMPLATE,
|
|
} from '../paths.js';
|
|
import { getAgentGitPaths } from '../services/agent-git-paths.js';
|
|
import { getContainer, getOrCreateContainer, removeContainer } from '../services/container.js';
|
|
import { classifyErrorForTemporal, PentestError } from '../services/error-handling.js';
|
|
import { ExploitationCheckerService } from '../services/exploitation-checker.js';
|
|
import { renderFindingsFromQueues } from '../services/findings-renderer.js';
|
|
import { executeGitCommandWithRetry } from '../services/git-manager.js';
|
|
import { runPreflightChecks } from '../services/preflight.js';
|
|
import type { ExploitationDecision, VulnType } from '../services/queue-validation.js';
|
|
import type { ReportData, ReportMeta } from '../services/report-renderer.js';
|
|
import { assembleFinalReport, copyReportToRunRoot, injectModelIntoReport } from '../services/reporting.js';
|
|
import { validateAuthentication } from '../services/validate-authentication.js';
|
|
import { AGENTS } from '../session-manager.js';
|
|
import type { AgentName } from '../types/agents.js';
|
|
import { ALL_AGENTS } from '../types/agents.js';
|
|
import type { ContainerConfig, VulnClass } from '../types/config.js';
|
|
import { ErrorCode } from '../types/errors.js';
|
|
import { isErr } from '../types/result.js';
|
|
import { atomicWrite, fileExists, readJson } from '../utils/file-io.js';
|
|
import { createActivityLogger } from './activity-logger.js';
|
|
import type { AgentMetrics, PipelineState, ResumeState } from './shared.js';
|
|
|
|
// Max lengths to prevent Temporal protobuf buffer overflow
|
|
const MAX_ERROR_MESSAGE_LENGTH = 2000;
|
|
const MAX_STACK_TRACE_LENGTH = 1000;
|
|
|
|
// Max retries for output validation errors (agent didn't save deliverables)
|
|
const MAX_OUTPUT_VALIDATION_RETRIES = 3;
|
|
|
|
const HEARTBEAT_INTERVAL_MS = 2000;
|
|
|
|
/**
|
|
* Input for all agent activities.
|
|
*
|
|
* Config fields are optional with sensible defaults. When provided, they
|
|
* flow through to getOrCreateContainer() for path configuration.
|
|
*/
|
|
export interface ActivityInput {
|
|
webUrl: string;
|
|
repoPath: string;
|
|
configPath?: string;
|
|
outputPath?: string;
|
|
pipelineTestingMode?: boolean;
|
|
workflowId: string;
|
|
sessionId: string;
|
|
|
|
// Config fields — serializable, read by getOrCreateContainer()
|
|
configYAML?: string;
|
|
deliverablesSubdir?: string;
|
|
auditDir?: string;
|
|
promptDir?: string;
|
|
sastSarifPath?: string;
|
|
|
|
// Vuln classes whose pipeline failed. Set before the report stage on a partial run so the
|
|
// report marks them "not assessed" instead of asserting no findings were present.
|
|
failedClasses?: VulnClass[];
|
|
}
|
|
|
|
/**
|
|
* Truncate error message to prevent buffer overflow in Temporal serialization.
|
|
*/
|
|
function truncateErrorMessage(message: string): string {
|
|
if (message.length <= MAX_ERROR_MESSAGE_LENGTH) {
|
|
return message;
|
|
}
|
|
return `${message.slice(0, MAX_ERROR_MESSAGE_LENGTH - 20)}\n[truncated]`;
|
|
}
|
|
|
|
/**
|
|
* Truncate stack trace on an ApplicationFailure to prevent buffer overflow.
|
|
*/
|
|
function truncateStackTrace(failure: ApplicationFailure): void {
|
|
if (failure.stack && failure.stack.length > MAX_STACK_TRACE_LENGTH) {
|
|
failure.stack = `${failure.stack.slice(0, MAX_STACK_TRACE_LENGTH)}\n[stack truncated]`;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Build SessionMetadata from ActivityInput.
|
|
*/
|
|
function buildSessionMetadata(input: ActivityInput): SessionMetadata {
|
|
const { webUrl, repoPath, outputPath, sessionId } = input;
|
|
return {
|
|
id: sessionId,
|
|
webUrl,
|
|
repoPath,
|
|
...(outputPath && { outputPath }),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Build ContainerConfig from ActivityInput, falling back to defaults.
|
|
*/
|
|
function buildContainerConfig(input: ActivityInput): ContainerConfig {
|
|
return {
|
|
deliverablesSubdir: input.deliverablesSubdir ?? DEFAULT_DELIVERABLES_SUBDIR,
|
|
auditDir: input.auditDir ?? './workspaces',
|
|
...(input.promptDir !== undefined && { promptDir: input.promptDir }),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Core activity implementation using services.
|
|
*
|
|
* Executes a single agent with:
|
|
* 1. Heartbeat loop for worker liveness
|
|
* 2. Container creation/reuse
|
|
* 3. Service-based agent execution
|
|
* 4. Error classification for Temporal retry
|
|
*/
|
|
async function runAgentActivity(
|
|
agentName: AgentName,
|
|
input: ActivityInput,
|
|
customTools?: import('@earendil-works/pi-coding-agent').ToolDefinition[],
|
|
writeDeliverable?: (deliverablesPath: string) => Promise<void>,
|
|
): Promise<AgentMetrics> {
|
|
const { repoPath, configPath, pipelineTestingMode = false, workflowId, webUrl } = input;
|
|
|
|
// Skip guard: the checkpoint provider decides whether to run the agent.
|
|
// The default NoOp provider always returns { skip: false }.
|
|
const skipContainer =
|
|
getContainer(workflowId) ??
|
|
getOrCreateContainer(workflowId, buildSessionMetadata(input), buildContainerConfig(input));
|
|
const decision = await skipContainer.checkpointProvider.shouldSkipAgent(
|
|
agentName,
|
|
repoPath,
|
|
input.deliverablesSubdir ?? DEFAULT_DELIVERABLES_SUBDIR,
|
|
);
|
|
if (decision.skip && decision.metrics) {
|
|
return { ...decision.metrics, skipped: true };
|
|
}
|
|
|
|
const startTime = Date.now();
|
|
const attemptNumber = Context.current().info.attempt;
|
|
|
|
// Heartbeat loop - signals worker is alive to Temporal server
|
|
const heartbeatInterval = setInterval(() => {
|
|
const elapsed = Math.floor((Date.now() - startTime) / 1000);
|
|
heartbeat({ agent: agentName, elapsedSeconds: elapsed, attempt: attemptNumber });
|
|
}, HEARTBEAT_INTERVAL_MS);
|
|
|
|
try {
|
|
const logger = createActivityLogger();
|
|
|
|
// 1. Build session metadata and get/create container
|
|
const sessionMetadata = buildSessionMetadata(input);
|
|
const container = getOrCreateContainer(workflowId, sessionMetadata, buildContainerConfig(input));
|
|
|
|
// 2. Create audit session for THIS agent execution
|
|
// NOTE: Each agent needs its own AuditSession because AuditSession uses
|
|
// instance state (currentAgentName) that cannot be shared across parallel agents
|
|
const auditSession = new AuditSession(sessionMetadata);
|
|
await auditSession.initialize(workflowId);
|
|
|
|
// 3. Execute agent via service (throws PentestError on failure)
|
|
const deliverablesPath = deliverablesDir(repoPath, container.config.deliverablesSubdir);
|
|
const endResult = await container.agentExecution.executeOrThrow(
|
|
agentName,
|
|
{
|
|
webUrl,
|
|
repoPath,
|
|
deliverablesPath,
|
|
configPath,
|
|
pipelineTestingMode,
|
|
attemptNumber,
|
|
...(input.promptDir !== undefined && { promptDir: input.promptDir }),
|
|
...(input.configYAML !== undefined && { configYAML: input.configYAML }),
|
|
...(input.failedClasses !== undefined && { failedClasses: input.failedClasses }),
|
|
...(customTools && { customTools }),
|
|
...(writeDeliverable && { writeDeliverable }),
|
|
cancellationSignal: Context.current().cancellationSignal,
|
|
},
|
|
auditSession,
|
|
logger,
|
|
);
|
|
|
|
// 4. Return metrics
|
|
return {
|
|
durationMs: Date.now() - startTime,
|
|
inputTokens: endResult.input_tokens ?? null,
|
|
outputTokens: endResult.output_tokens ?? null,
|
|
cacheReadTokens: endResult.cache_read_tokens ?? null,
|
|
cacheWriteTokens: endResult.cache_write_tokens ?? null,
|
|
costUsd: endResult.cost_usd,
|
|
numTurns: endResult.turns ?? null,
|
|
model: endResult.model,
|
|
};
|
|
} catch (error) {
|
|
// If error is already an ApplicationFailure, re-throw directly
|
|
if (error instanceof ApplicationFailure) {
|
|
throw error;
|
|
}
|
|
|
|
// Check if output validation retry limit reached (PentestError with code)
|
|
if (
|
|
error instanceof PentestError &&
|
|
error.code === ErrorCode.OUTPUT_VALIDATION_FAILED &&
|
|
attemptNumber >= MAX_OUTPUT_VALIDATION_RETRIES
|
|
) {
|
|
throw ApplicationFailure.nonRetryable(
|
|
`Agent ${agentName} failed output validation after ${attemptNumber} attempts`,
|
|
'OutputValidationError',
|
|
[{ agentName, attemptNumber, elapsed: Date.now() - startTime }],
|
|
);
|
|
}
|
|
|
|
// Classify error for Temporal retry behavior
|
|
const classified = classifyErrorForTemporal(error);
|
|
const rawMessage = error instanceof Error ? error.message : String(error);
|
|
const message = truncateErrorMessage(rawMessage);
|
|
|
|
if (classified.retryable) {
|
|
const failure = ApplicationFailure.create({
|
|
message,
|
|
type: classified.type,
|
|
details: [{ agentName, attemptNumber, elapsed: Date.now() - startTime }],
|
|
});
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
} else {
|
|
const failure = ApplicationFailure.nonRetryable(message, classified.type, [
|
|
{ agentName, attemptNumber, elapsed: Date.now() - startTime },
|
|
]);
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
}
|
|
} finally {
|
|
clearInterval(heartbeatInterval);
|
|
}
|
|
}
|
|
|
|
export async function runPreReconAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
const { createPreReconCollector } = await import('../collectors/pre-recon-collector.js');
|
|
const { renderPreRecon } = await import('../services/pre-recon-renderer.js');
|
|
|
|
const collector = createPreReconCollector();
|
|
|
|
const writeDeliverable = async (deliverablesPath: string): Promise<void> => {
|
|
const logger = createActivityLogger();
|
|
// Skipped tools surface as renderer placeholders, not as activity failures.
|
|
const callStatus = collector.getCallStatus();
|
|
logger.info('Pre-recon tool call status', { callStatus });
|
|
|
|
const collected = collector.getAll();
|
|
const markdown = renderPreRecon(collected);
|
|
const mdPath = path.join(deliverablesPath, 'pre_recon_deliverable.md');
|
|
await atomicWrite(mdPath, markdown);
|
|
logger.info(`Wrote pre_recon_deliverable.md from structured data (${markdown.length} bytes)`);
|
|
};
|
|
|
|
return runAgentActivity('pre-recon', input, collector.tools, writeDeliverable);
|
|
}
|
|
|
|
export async function runReconAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
const { createReconCollector } = await import('../collectors/recon-collector.js');
|
|
const { renderRecon } = await import('../services/recon-renderer.js');
|
|
|
|
const collector = createReconCollector();
|
|
|
|
const writeDeliverable = async (deliverablesPath: string): Promise<void> => {
|
|
const logger = createActivityLogger();
|
|
// Skipped tools surface as renderer placeholders, not as activity failures.
|
|
const callStatus = collector.getCallStatus();
|
|
logger.info('Recon tool call status', { callStatus });
|
|
|
|
const collected = collector.getAll();
|
|
const markdown = renderRecon(collected);
|
|
const mdPath = path.join(deliverablesPath, 'recon_deliverable.md');
|
|
await atomicWrite(mdPath, markdown);
|
|
logger.info(`Wrote recon_deliverable.md from structured data (${markdown.length} bytes)`);
|
|
};
|
|
|
|
return runAgentActivity('recon', input, collector.tools, writeDeliverable);
|
|
}
|
|
|
|
async function runVulnAgentWithCollector(
|
|
agentName: 'injection-vuln' | 'xss-vuln' | 'auth-vuln' | 'ssrf-vuln' | 'authz-vuln',
|
|
vulnClass: 'injection' | 'xss' | 'auth' | 'ssrf' | 'authz',
|
|
input: ActivityInput,
|
|
): Promise<AgentMetrics> {
|
|
const { createVulnCollector } = await import('../collectors/vuln-collector.js');
|
|
const { renderVulnDeliverable } = await import('../services/vuln-renderer.js');
|
|
|
|
const collector = createVulnCollector(vulnClass);
|
|
|
|
const writeDeliverable = async (deliverablesPath: string): Promise<void> => {
|
|
const logger = createActivityLogger();
|
|
// Skipped tools surface as renderer placeholders, not as activity failures.
|
|
const callStatus = collector.getCallStatus();
|
|
logger.info(`${vulnClass} vuln tool call status`, { callStatus });
|
|
|
|
const collected = collector.getAll();
|
|
const markdown = renderVulnDeliverable(vulnClass, collected);
|
|
const mdPath = path.join(deliverablesPath, `${vulnClass}_analysis_deliverable.md`);
|
|
await atomicWrite(mdPath, markdown);
|
|
logger.info(`Wrote ${vulnClass}_analysis_deliverable.md from structured data (${markdown.length} bytes)`);
|
|
};
|
|
|
|
return runAgentActivity(agentName, input, collector.tools, writeDeliverable);
|
|
}
|
|
|
|
export async function runInjectionVulnAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runVulnAgentWithCollector('injection-vuln', 'injection', input);
|
|
}
|
|
|
|
export async function runXssVulnAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runVulnAgentWithCollector('xss-vuln', 'xss', input);
|
|
}
|
|
|
|
export async function runAuthVulnAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runVulnAgentWithCollector('auth-vuln', 'auth', input);
|
|
}
|
|
|
|
export async function runSsrfVulnAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runVulnAgentWithCollector('ssrf-vuln', 'ssrf', input);
|
|
}
|
|
|
|
export async function runAuthzVulnAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runVulnAgentWithCollector('authz-vuln', 'authz', input);
|
|
}
|
|
|
|
interface ExploitQueueEntry {
|
|
ID?: string;
|
|
vulnerability_type?: string;
|
|
}
|
|
|
|
interface ExploitQueueDocument {
|
|
vulnerabilities?: ExploitQueueEntry[];
|
|
}
|
|
|
|
async function readExploitQueue(queuePath: string): Promise<{ validIds: Set<string>; idToType: Map<string, string> }> {
|
|
const validIds = new Set<string>();
|
|
const idToType = new Map<string, string>();
|
|
if (!(await fileExists(queuePath))) {
|
|
return { validIds, idToType };
|
|
}
|
|
let doc: ExploitQueueDocument;
|
|
try {
|
|
doc = await readJson<ExploitQueueDocument>(queuePath);
|
|
} catch (error) {
|
|
const rawMessage = error instanceof Error ? error.message : String(error);
|
|
const failure = ApplicationFailure.nonRetryable(
|
|
truncateErrorMessage(`Invalid exploitation queue ${queuePath}: ${rawMessage}`),
|
|
'InvalidExploitationQueueError',
|
|
[{ queuePath }],
|
|
);
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
}
|
|
for (const entry of doc.vulnerabilities ?? []) {
|
|
if (!entry.ID) continue;
|
|
validIds.add(entry.ID);
|
|
idToType.set(entry.ID, entry.vulnerability_type ?? 'unknown');
|
|
}
|
|
return { validIds, idToType };
|
|
}
|
|
|
|
async function runExploitAgentWithCollector(
|
|
agentName: 'injection-exploit' | 'xss-exploit' | 'auth-exploit' | 'ssrf-exploit' | 'authz-exploit',
|
|
vulnClass: 'injection' | 'xss' | 'auth' | 'ssrf' | 'authz',
|
|
input: ActivityInput,
|
|
): Promise<AgentMetrics> {
|
|
const { createExploitCollector } = await import('../collectors/exploit-collector.js');
|
|
const { renderExploitDeliverable } = await import('../services/exploit-renderer.js');
|
|
|
|
const dir = deliverablesDir(input.repoPath, input.deliverablesSubdir);
|
|
const queuePath = path.join(dir, `${vulnClass}_exploitation_queue.json`);
|
|
const { validIds, idToType } = await readExploitQueue(queuePath);
|
|
|
|
const collector = createExploitCollector({ vulnClass, validIds });
|
|
|
|
const writeDeliverable = async (deliverablesPath: string): Promise<void> => {
|
|
const logger = createActivityLogger();
|
|
const collected = collector.getAll();
|
|
const emittedIds = new Set(collected.map((e) => e.vulnerability_id));
|
|
const missingIds = [...validIds].filter((id) => !emittedIds.has(id));
|
|
const exploitedCount = collected.filter((e) => e.status === 'exploited').length;
|
|
const blockedCount = collected.filter((e) => e.status === 'blocked').length;
|
|
|
|
logger.info(`${vulnClass} exploit tool call metrics`, {
|
|
queueSize: validIds.size,
|
|
exploited: exploitedCount,
|
|
blocked: blockedCount,
|
|
missing: missingIds.length,
|
|
});
|
|
|
|
const markdown = renderExploitDeliverable(vulnClass, collected, idToType);
|
|
const mdPath = path.join(deliverablesPath, `${vulnClass}_exploitation_evidence.md`);
|
|
await atomicWrite(mdPath, markdown);
|
|
logger.info(`Wrote ${vulnClass}_exploitation_evidence.md from structured data (${markdown.length} bytes)`);
|
|
};
|
|
|
|
return runAgentActivity(agentName, input, collector.tools, writeDeliverable);
|
|
}
|
|
|
|
export async function runInjectionExploitAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runExploitAgentWithCollector('injection-exploit', 'injection', input);
|
|
}
|
|
|
|
export async function runXssExploitAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runExploitAgentWithCollector('xss-exploit', 'xss', input);
|
|
}
|
|
|
|
export async function runAuthExploitAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runExploitAgentWithCollector('auth-exploit', 'auth', input);
|
|
}
|
|
|
|
export async function runSsrfExploitAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runExploitAgentWithCollector('ssrf-exploit', 'ssrf', input);
|
|
}
|
|
|
|
export async function runAuthzExploitAgent(input: ActivityInput): Promise<AgentMetrics> {
|
|
return runExploitAgentWithCollector('authz-exploit', 'authz', input);
|
|
}
|
|
|
|
/**
|
|
* Write report.sarif when the run is exploitative and the operator asked for it.
|
|
*
|
|
* Skipped entirely for analysis-only runs. The original reason was that those findings carried
|
|
* no severity, so every `result.level` would have been invented; since severity is recorded in
|
|
* both modes an analysis run could now populate `level`, but it would report an assessed
|
|
* severity as a measured one, so the gate stays. Failures are logged and swallowed — the SARIF
|
|
* log is a secondary artifact and must not fail a run whose report is already written.
|
|
*/
|
|
async function writeSarifIfEnabled(
|
|
input: ActivityInput,
|
|
exploit: boolean,
|
|
reportData: ReportData,
|
|
deliverablesPath: string,
|
|
logger: ReturnType<typeof createActivityLogger>,
|
|
): Promise<void> {
|
|
if (!exploit) return;
|
|
|
|
const container = getOrCreateContainer(input.workflowId, buildSessionMetadata(input), buildContainerConfig(input));
|
|
const configResult = await container.configLoader.loadOptional(input.configPath, undefined, input.configYAML);
|
|
if (isErr(configResult) || configResult.value?.report?.sarif !== true) return;
|
|
|
|
try {
|
|
const { renderSarif } = await import('../services/sarif-renderer.js');
|
|
const sarif = renderSarif(reportData, { workspaceName: input.sessionId });
|
|
await atomicWrite(path.join(deliverablesPath, SARIF_FILENAME), sarif);
|
|
logger.info(`Wrote ${SARIF_FILENAME}`);
|
|
} catch (error) {
|
|
logger.warn(`Failed to write ${SARIF_FILENAME}: ${(error as Error).message}`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Compile the PDF report from the assembled report data.
|
|
*
|
|
* Failures are logged and swallowed — the PDF is a secondary artifact and must not fail a run
|
|
* whose report is already written.
|
|
*/
|
|
async function writePdfReport(
|
|
reportData: ReportData,
|
|
deliverablesPath: string,
|
|
logger: ReturnType<typeof createActivityLogger>,
|
|
): Promise<void> {
|
|
try {
|
|
const { renderReportPdf } = await import('../services/pdf-renderer.js');
|
|
await renderReportPdf({
|
|
reportData,
|
|
templatePath: TYPST_TEMPLATE,
|
|
outputPath: path.join(deliverablesPath, ASSEMBLED_REPORT_PDF_FILENAME),
|
|
});
|
|
logger.info(`Wrote ${ASSEMBLED_REPORT_PDF_FILENAME}`);
|
|
} catch (error) {
|
|
logger.warn(`Failed to write ${ASSEMBLED_REPORT_PDF_FILENAME}: ${(error as Error).message}`);
|
|
}
|
|
}
|
|
|
|
export async function runReportAgent(input: ActivityInput, exploit: boolean): Promise<AgentMetrics> {
|
|
const { createFindingCollector } = await import('../collectors/finding-collector.js');
|
|
const { renderReport } = await import('../services/report-renderer.js');
|
|
|
|
const collector = createFindingCollector(exploit);
|
|
|
|
const writeDeliverable = async (deliverablesPath: string): Promise<void> => {
|
|
const logger = createActivityLogger();
|
|
const { attachQueueCodeLocations } = await import('../services/code-location-join.js');
|
|
const collected = collector.getAll();
|
|
logger.info(`Collected ${collected.length} finding(s) from report agent`);
|
|
const findings = await attachQueueCodeLocations(collected, deliverablesPath, logger);
|
|
|
|
// report_meta is written by the set-report-meta CLI while the agent runs; read it back so
|
|
// the two halves of report.json end up in one document.
|
|
const reportJsonPath = path.join(deliverablesPath, REPORT_JSON_FILENAME);
|
|
let reportMeta: ReportMeta = {
|
|
target: input.webUrl,
|
|
assessment_date: new Date().toISOString().split('T')[0]!,
|
|
scope: '',
|
|
executive_summary: '',
|
|
exploit,
|
|
};
|
|
if (await fileExists(reportJsonPath)) {
|
|
try {
|
|
const existing = await readJson<{ report_meta?: Record<string, unknown> }>(reportJsonPath);
|
|
if (existing.report_meta) {
|
|
reportMeta = {
|
|
target: String(existing.report_meta.target ?? input.webUrl),
|
|
assessment_date: String(existing.report_meta.assessment_date ?? reportMeta.assessment_date),
|
|
scope: String(existing.report_meta.scope ?? ''),
|
|
executive_summary: String(existing.report_meta.executive_summary ?? ''),
|
|
// Run scope, not agent output — keeps the rendered report and the schema the agent
|
|
// was given in agreement.
|
|
exploit,
|
|
...(existing.report_meta.model !== undefined && { model: String(existing.report_meta.model) }),
|
|
};
|
|
}
|
|
} catch {
|
|
logger.warn('Failed to read report_meta from report.json, using defaults');
|
|
}
|
|
}
|
|
|
|
const reportData: ReportData = {
|
|
report_meta: reportMeta,
|
|
findings,
|
|
...(input.failedClasses && input.failedClasses.length > 0 && { not_assessed: input.failedClasses }),
|
|
};
|
|
|
|
await atomicWrite(reportJsonPath, JSON.stringify(reportData, null, 2));
|
|
logger.info(`Wrote ${REPORT_JSON_FILENAME} with ${findings.length} finding(s)`);
|
|
|
|
await atomicWrite(path.join(deliverablesPath, ASSEMBLED_REPORT_FILENAME), renderReport(reportData));
|
|
logger.info(`Wrote ${ASSEMBLED_REPORT_FILENAME} from structured data`);
|
|
|
|
await writePdfReport(reportData, deliverablesPath, logger);
|
|
await writeSarifIfEnabled(input, exploit, reportData, deliverablesPath, logger);
|
|
};
|
|
|
|
return runAgentActivity('report', input, collector.tools, writeDeliverable);
|
|
}
|
|
|
|
/**
|
|
* Preflight validation activity.
|
|
*
|
|
* Runs cheap checks before any agent execution:
|
|
* 1. Repository path exists and is a directory
|
|
* 2. Config file validates (if provided)
|
|
* 3. Credential validation (API key, OAuth, or Bedrock)
|
|
* 4. Target URL reachable from the container
|
|
*
|
|
* NOT using runAgentActivity — preflight doesn't run a full analysis agent.
|
|
*/
|
|
export async function runPreflightValidation(input: ActivityInput): Promise<void> {
|
|
const startTime = Date.now();
|
|
const attemptNumber = Context.current().info.attempt;
|
|
|
|
const heartbeatInterval = setInterval(() => {
|
|
const elapsed = Math.floor((Date.now() - startTime) / 1000);
|
|
heartbeat({ phase: 'preflight', elapsedSeconds: elapsed, attempt: attemptNumber });
|
|
}, HEARTBEAT_INTERVAL_MS);
|
|
|
|
try {
|
|
const logger = createActivityLogger();
|
|
logger.info('Running preflight validation...', { attempt: attemptNumber });
|
|
|
|
const result = await runPreflightChecks(input.webUrl, input.repoPath, input.configPath, logger);
|
|
|
|
if (isErr(result)) {
|
|
const classified = classifyErrorForTemporal(result.error);
|
|
const message = truncateErrorMessage(result.error.message);
|
|
|
|
if (classified.retryable) {
|
|
const failure = ApplicationFailure.create({
|
|
message,
|
|
type: classified.type,
|
|
details: [{ phase: 'preflight', attemptNumber, elapsed: Date.now() - startTime }],
|
|
});
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
} else {
|
|
const failure = ApplicationFailure.nonRetryable(message, classified.type, [
|
|
{ phase: 'preflight', attemptNumber, elapsed: Date.now() - startTime },
|
|
]);
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
}
|
|
}
|
|
|
|
logger.info('Preflight validation passed');
|
|
} catch (error) {
|
|
if (error instanceof ApplicationFailure) {
|
|
throw error;
|
|
}
|
|
|
|
const classified = classifyErrorForTemporal(error);
|
|
const rawMessage = error instanceof Error ? error.message : String(error);
|
|
const message = truncateErrorMessage(rawMessage);
|
|
|
|
const failure = ApplicationFailure.nonRetryable(message, classified.type, [
|
|
{ phase: 'preflight', attemptNumber, elapsed: Date.now() - startTime },
|
|
]);
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
} finally {
|
|
clearInterval(heartbeatInterval);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Authentication validation activity. No-ops without an authentication
|
|
* block; otherwise surfaces a classified failure (failurePoint +
|
|
* failureDetail in ApplicationFailure.details) on credential rejection.
|
|
*/
|
|
export async function runAuthenticationValidation(input: ActivityInput): Promise<void> {
|
|
const startTime = Date.now();
|
|
const attemptNumber = Context.current().info.attempt;
|
|
|
|
const heartbeatInterval = setInterval(() => {
|
|
const elapsed = Math.floor((Date.now() - startTime) / 1000);
|
|
heartbeat({ phase: 'auth-validation', elapsedSeconds: elapsed, attempt: attemptNumber });
|
|
}, HEARTBEAT_INTERVAL_MS);
|
|
|
|
try {
|
|
const logger = createActivityLogger();
|
|
|
|
const sessionMetadata = buildSessionMetadata(input);
|
|
const container = getOrCreateContainer(input.workflowId, sessionMetadata, buildContainerConfig(input));
|
|
const configResult = await container.configLoader.loadOptional(input.configPath, undefined, input.configYAML);
|
|
if (isErr(configResult)) {
|
|
// runPreflightValidation already validated parsing, so this is unexpected.
|
|
logger.warn(`runAuthenticationValidation: config load failed unexpectedly: ${configResult.error.message}`);
|
|
return;
|
|
}
|
|
|
|
const distributedConfig = configResult.value;
|
|
if (!distributedConfig?.authentication) {
|
|
logger.info('No authentication configured — skipping credential validation');
|
|
return;
|
|
}
|
|
|
|
const auditSession = new AuditSession(sessionMetadata);
|
|
await auditSession.initialize(input.workflowId);
|
|
|
|
const result = await validateAuthentication({
|
|
distributedConfig,
|
|
repoPath: input.repoPath,
|
|
webUrl: input.webUrl,
|
|
logger,
|
|
auditSession,
|
|
attemptNumber,
|
|
...(input.deliverablesSubdir !== undefined && { deliverablesSubdir: input.deliverablesSubdir }),
|
|
...(input.promptDir !== undefined && { promptDir: input.promptDir }),
|
|
...(input.pipelineTestingMode !== undefined && { pipelineTestingMode: input.pipelineTestingMode }),
|
|
cancellationSignal: Context.current().cancellationSignal,
|
|
});
|
|
|
|
if (isErr(result)) {
|
|
const classified = classifyErrorForTemporal(result.error);
|
|
const message = truncateErrorMessage(result.error.message);
|
|
const ctx = result.error.context;
|
|
const details = [
|
|
{
|
|
phase: 'auth-validation',
|
|
attemptNumber,
|
|
elapsed: Date.now() - startTime,
|
|
...(ctx.failurePoint !== undefined && { failurePoint: ctx.failurePoint }),
|
|
...(ctx.failureDetail !== undefined && { failureDetail: ctx.failureDetail }),
|
|
},
|
|
];
|
|
|
|
const failure = classified.retryable
|
|
? ApplicationFailure.create({ message, type: classified.type, details })
|
|
: ApplicationFailure.nonRetryable(message, classified.type, details);
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
}
|
|
} catch (error) {
|
|
if (error instanceof ApplicationFailure) {
|
|
throw error;
|
|
}
|
|
|
|
const classified = classifyErrorForTemporal(error);
|
|
const rawMessage = error instanceof Error ? error.message : String(error);
|
|
const message = truncateErrorMessage(rawMessage);
|
|
const details = [{ phase: 'auth-validation', attemptNumber, elapsed: Date.now() - startTime }];
|
|
|
|
const failure = classified.retryable
|
|
? ApplicationFailure.create({ message, type: classified.type, details })
|
|
: ApplicationFailure.nonRetryable(message, classified.type, details);
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
} finally {
|
|
clearInterval(heartbeatInterval);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Initialize a private git repository inside the workspace deliverables directory.
|
|
* Idempotent — skips if .git already exists (resume case).
|
|
*/
|
|
export async function initDeliverableGit(input: ActivityInput): Promise<void> {
|
|
const deliverablesPath = deliverablesDir(input.repoPath, input.deliverablesSubdir);
|
|
await fs.mkdir(deliverablesPath, { recursive: true });
|
|
|
|
// Check for .git directly inside deliverables, not parent repo's .git
|
|
const dotGitPath = path.join(deliverablesPath, '.git');
|
|
try {
|
|
await fs.stat(dotGitPath);
|
|
return;
|
|
} catch {
|
|
// .git doesn't exist, proceed with init
|
|
}
|
|
|
|
await executeGitCommandWithRetry(['git', 'init'], deliverablesPath, 'init deliverables repo');
|
|
await executeGitCommandWithRetry(
|
|
['git', 'commit', '--allow-empty', '-m', '📍 Initial deliverables checkpoint'],
|
|
deliverablesPath,
|
|
'initial checkpoint',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Drop a stealth cli.config.json into the repo's .playwright/ directory so
|
|
* `playwright-cli open` auto-loads anti-detection defaults from the agent's
|
|
* cwd (disables the Blink AutomationControlled flag, drops the
|
|
* --enable-automation default, and overrides the HeadlessChrome user agent).
|
|
*
|
|
* No-op when the repo already has its own .playwright/cli.config.json.
|
|
*/
|
|
export async function syncPlaywrightStealthConfig(input: ActivityInput): Promise<void> {
|
|
const logger = createActivityLogger();
|
|
const { result, configPath } = await writePlaywrightStealthConfig(input.repoPath);
|
|
if (result === 'skipped-existing') {
|
|
logger.info(`Playwright stealth config: leaving existing ${configPath} in place`);
|
|
} else {
|
|
logger.info(`Playwright stealth config: wrote ${configPath}`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sync code_path avoid rules into the @gotgenes/pi-permission-system global config
|
|
* so pi enforces them at the tool layer for every agent in this run. The executor
|
|
* loads the extension when this config is present (see pi-executor).
|
|
*
|
|
* Runs once per workflow before any analysis agent fires. Config is fixed for the
|
|
* lifetime of the workflow, so writing once avoids a parallel-agent race on the
|
|
* global config file.
|
|
*/
|
|
export async function syncCodePathDenyRules(input: ActivityInput): Promise<void> {
|
|
const logger = createActivityLogger();
|
|
const container = getOrCreateContainer(input.workflowId, buildSessionMetadata(input), buildContainerConfig(input));
|
|
|
|
const configResult = await container.configLoader.loadOptional(input.configPath, undefined, input.configYAML);
|
|
if (isErr(configResult)) {
|
|
logger.warn(`syncCodePathDenyRules: skipping (config load failed: ${configResult.error.message})`);
|
|
return;
|
|
}
|
|
|
|
const config = configResult.value;
|
|
const denyCount = (config?.avoid ?? []).filter((r) => r.type === 'code_path').length;
|
|
syncPermissionSystemConfig(config);
|
|
logger.info(
|
|
denyCount > 0
|
|
? `Synced ${denyCount} code_path deny rule(s) to the pi-permission-system config`
|
|
: 'No code_path deny rules; pi-permission-system config cleared',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Assemble the final report by concatenating per-class deliverables.
|
|
*
|
|
* Under exploit=true, each exploit agent has produced `*_exploitation_evidence.md`
|
|
* directly. Under exploit=false, exploit agents didn't run; we deterministically
|
|
* render `*_findings.md` from each `*_exploitation_queue.json` first, then assemble.
|
|
*/
|
|
export async function assembleReportActivity(input: ActivityInput, exploit: boolean): Promise<void> {
|
|
const { repoPath, deliverablesSubdir } = input;
|
|
const logger = createActivityLogger();
|
|
|
|
if (!exploit) {
|
|
logger.info('Rendering per-class findings from analysis queues...');
|
|
try {
|
|
await renderFindingsFromQueues(repoPath, deliverablesSubdir, logger);
|
|
} catch (error) {
|
|
const err = error as Error;
|
|
logger.warn(`Error rendering findings from queues: ${err.message}`);
|
|
}
|
|
}
|
|
|
|
logger.info('Assembling deliverables from specialist agents...');
|
|
try {
|
|
await assembleFinalReport(repoPath, deliverablesSubdir, logger);
|
|
} catch (error) {
|
|
const err = error as Error;
|
|
logger.warn(`Error assembling final report: ${err.message}`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Inject model metadata into the final report.
|
|
*/
|
|
export async function injectReportMetadataActivity(input: ActivityInput): Promise<void> {
|
|
const { repoPath, sessionId, outputPath, deliverablesSubdir } = input;
|
|
const logger = createActivityLogger();
|
|
const effectiveOutputPath = outputPath ? path.join(outputPath, sessionId) : path.join('./workspaces', sessionId);
|
|
try {
|
|
await injectModelIntoReport(repoPath, deliverablesSubdir, effectiveOutputPath, logger);
|
|
} catch (error) {
|
|
const err = error as Error;
|
|
logger.warn(`Error injecting model into report: ${err.message}`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if exploitation should run for a given vulnerability type.
|
|
*
|
|
* Uses existing container if available (from prior agent runs),
|
|
* otherwise creates service directly (stateless, no dependencies).
|
|
*/
|
|
export async function checkExploitationQueue(input: ActivityInput, vulnType: VulnType): Promise<ExploitationDecision> {
|
|
const { repoPath, workflowId } = input;
|
|
const logger = createActivityLogger();
|
|
|
|
// Reuse container's service if available (from prior vuln agent runs)
|
|
const existingContainer = getContainer(workflowId);
|
|
const checker = existingContainer?.exploitationChecker ?? new ExploitationCheckerService();
|
|
|
|
// Pass deliverablesPath (not repoPath) — validators expect the deliverables directory
|
|
const delivPath = deliverablesDir(repoPath, input.deliverablesSubdir);
|
|
try {
|
|
return await checker.checkQueue(vulnType, delivPath, logger);
|
|
} catch (error) {
|
|
const classified = classifyErrorForTemporal(error);
|
|
const message = truncateErrorMessage(error instanceof Error ? error.message : String(error));
|
|
const details = [{ phase: 'check-exploitation-queue', vulnType }];
|
|
const queueValidationFailure = error instanceof PentestError && error.type === 'validation';
|
|
// A code-less PentestError (e.g. a filesystem read failure) is classified by
|
|
// string-matching, which can miss its retryable flag. Trust the flag directly so
|
|
// a non-retryable error never gets a Temporal retry.
|
|
const pentestNonRetryable = error instanceof PentestError && !error.retryable;
|
|
|
|
const failure =
|
|
queueValidationFailure || pentestNonRetryable || !classified.retryable
|
|
? ApplicationFailure.nonRetryable(
|
|
message,
|
|
queueValidationFailure ? 'InvalidExploitationQueueError' : classified.type,
|
|
details,
|
|
)
|
|
: ApplicationFailure.create({ message, type: classified.type, details });
|
|
truncateStackTrace(failure);
|
|
throw failure;
|
|
}
|
|
}
|
|
|
|
interface RunScope {
|
|
vulnClasses: VulnClass[];
|
|
exploit: boolean;
|
|
}
|
|
|
|
interface SessionJson {
|
|
session: {
|
|
id: string;
|
|
webUrl: string;
|
|
repoPath?: string;
|
|
originalWorkflowId?: string;
|
|
resumeAttempts?: ResumeAttempt[];
|
|
scope?: RunScope;
|
|
};
|
|
metrics: {
|
|
agents: Record<
|
|
string,
|
|
{
|
|
status: 'in-progress' | 'success' | 'failed';
|
|
checkpoint?: string;
|
|
}
|
|
>;
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Load resume state from an existing workspace.
|
|
*/
|
|
export async function loadResumeState(
|
|
workspaceName: string,
|
|
expectedUrl: string,
|
|
expectedRepoPath: string,
|
|
deliverablesSubdir?: string,
|
|
): Promise<ResumeState> {
|
|
// 1. Validate workspace exists (prefers .shannon/, falls back to legacy run-root layout)
|
|
const sessionPath = resolveSessionJsonPath(path.join('./workspaces', workspaceName));
|
|
|
|
const exists = await fileExists(sessionPath);
|
|
if (!exists) {
|
|
throw ApplicationFailure.nonRetryable(
|
|
`Workspace not found: ${workspaceName}\nExpected path: ${sessionPath}`,
|
|
'WorkspaceNotFoundError',
|
|
);
|
|
}
|
|
|
|
// 2. Parse session.json and validate URL match
|
|
let session: SessionJson;
|
|
try {
|
|
session = await readJson<SessionJson>(sessionPath);
|
|
} catch (error) {
|
|
const errorMsg = error instanceof Error ? error.message : String(error);
|
|
throw ApplicationFailure.nonRetryable(
|
|
`Corrupted session.json in workspace ${workspaceName}: ${errorMsg}`,
|
|
'CorruptedSessionError',
|
|
);
|
|
}
|
|
|
|
if (session.session.webUrl !== expectedUrl) {
|
|
throw ApplicationFailure.nonRetryable(
|
|
`URL mismatch with workspace\n Workspace URL: ${session.session.webUrl}\n Provided URL: ${expectedUrl}`,
|
|
'URLMismatchError',
|
|
);
|
|
}
|
|
|
|
// 3. Cross-check agent status with deliverables on disk
|
|
const completedAgents: string[] = [];
|
|
const agents = session.metrics.agents;
|
|
|
|
for (const agentName of ALL_AGENTS) {
|
|
const agentData = agents[agentName];
|
|
if (!agentData || agentData.status !== 'success') {
|
|
continue;
|
|
}
|
|
|
|
const deliverableFilename = AGENTS[agentName].deliverableFilename;
|
|
const deliverablePath = path.join(deliverablesDir(expectedRepoPath, deliverablesSubdir), deliverableFilename);
|
|
const deliverableExists = await fileExists(deliverablePath);
|
|
|
|
if (!deliverableExists) {
|
|
const logger = createActivityLogger();
|
|
logger.warn(`Agent ${agentName} shows success but deliverable missing, will re-run`);
|
|
continue;
|
|
}
|
|
|
|
completedAgents.push(agentName);
|
|
}
|
|
|
|
// 4. Collect git checkpoints and validate at least one exists
|
|
const checkpoints = completedAgents
|
|
.map((name) => agents[name]?.checkpoint)
|
|
.filter((hash): hash is string => hash != null);
|
|
|
|
if (checkpoints.length === 0) {
|
|
const successAgents = Object.entries(agents)
|
|
.filter(([, data]) => data.status === 'success')
|
|
.map(([name]) => name);
|
|
|
|
throw ApplicationFailure.nonRetryable(
|
|
`Cannot resume workspace ${workspaceName}: ` +
|
|
(successAgents.length > 0
|
|
? `${successAgents.length} agent(s) show success in session.json (${successAgents.join(', ')}) ` +
|
|
`but their deliverable files are missing from disk. ` +
|
|
`Start a fresh run instead.`
|
|
: `No agents completed successfully. Start a fresh run instead.`),
|
|
'NoCheckpointsError',
|
|
);
|
|
}
|
|
|
|
// 5. Find the most recent checkpoint commit
|
|
const deliverablesPath = deliverablesDir(expectedRepoPath, deliverablesSubdir);
|
|
const checkpointHash = await findLatestCommit(deliverablesPath, checkpoints);
|
|
const originalWorkflowId = session.session.originalWorkflowId || session.session.id;
|
|
|
|
// 6. Log summary and return resume state
|
|
const logger = createActivityLogger();
|
|
logger.info('Resume state loaded', {
|
|
workspace: workspaceName,
|
|
completedAgents: completedAgents.length,
|
|
checkpoint: checkpointHash,
|
|
});
|
|
|
|
return {
|
|
workspaceName,
|
|
originalUrl: session.session.webUrl,
|
|
completedAgents,
|
|
checkpointHash,
|
|
originalWorkflowId,
|
|
};
|
|
}
|
|
|
|
/** First run records scope into session.json; resume runs throw if it differs. */
|
|
export async function persistOrValidateRunScope(
|
|
input: ActivityInput,
|
|
vulnClasses: VulnClass[],
|
|
exploit: boolean,
|
|
): Promise<void> {
|
|
const sessionMetadata = buildSessionMetadata(input);
|
|
const auditSession = new AuditSession(sessionMetadata);
|
|
await auditSession.initialize(input.workflowId);
|
|
|
|
const sessionPath = generateSessionJsonPath(sessionMetadata);
|
|
let session: SessionJson;
|
|
try {
|
|
session = await readJson<SessionJson>(sessionPath);
|
|
} catch (error) {
|
|
const rawMessage = error instanceof Error ? error.message : String(error);
|
|
throw ApplicationFailure.nonRetryable(
|
|
`Corrupted session.json in workspace ${input.sessionId}: ${rawMessage}`,
|
|
'CorruptedSessionError',
|
|
);
|
|
}
|
|
|
|
if (session.session.scope) {
|
|
const recorded = session.session.scope;
|
|
const sameClasses =
|
|
recorded.vulnClasses.length === vulnClasses.length &&
|
|
recorded.vulnClasses.every((c) => vulnClasses.includes(c)) &&
|
|
vulnClasses.every((c) => recorded.vulnClasses.includes(c));
|
|
|
|
if (!sameClasses || recorded.exploit !== exploit) {
|
|
throw ApplicationFailure.nonRetryable(
|
|
`Resume scope mismatch for workspace ${input.sessionId}.\n` +
|
|
` Original: vuln_classes=[${recorded.vulnClasses.join(', ')}], exploit=${recorded.exploit}\n` +
|
|
` Provided: vuln_classes=[${vulnClasses.join(', ')}], exploit=${exploit}\n` +
|
|
`Resume requires the same scope as the original run. Start a new workspace if you want different scope.`,
|
|
'ScopeMismatchError',
|
|
);
|
|
}
|
|
return;
|
|
}
|
|
|
|
session.session.scope = { vulnClasses: [...vulnClasses], exploit };
|
|
await atomicWrite(sessionPath, session);
|
|
}
|
|
|
|
async function findLatestCommit(gitDir: string, commitHashes: string[]): Promise<string> {
|
|
if (commitHashes.length === 1) {
|
|
const hash = commitHashes[0];
|
|
if (!hash) {
|
|
throw new PentestError(
|
|
'Empty commit hash in array',
|
|
'filesystem',
|
|
false, // Non-retryable - corrupt workspace state
|
|
{ phase: 'resume' },
|
|
ErrorCode.GIT_CHECKPOINT_FAILED,
|
|
);
|
|
}
|
|
return hash;
|
|
}
|
|
|
|
const result = await executeGitCommandWithRetry(
|
|
['git', 'rev-list', '--max-count=1', ...commitHashes],
|
|
gitDir,
|
|
'find latest commit',
|
|
);
|
|
|
|
return result.stdout.trim();
|
|
}
|
|
|
|
/**
|
|
* Restore deliverables git to a checkpoint.
|
|
* Operates on the private git inside workspace deliverables, not the user's repo.
|
|
*/
|
|
export async function restoreGitCheckpoint(
|
|
repoPath: string,
|
|
checkpointHash: string,
|
|
incompleteAgents: AgentName[],
|
|
deliverablesSubdir?: string,
|
|
): Promise<void> {
|
|
const deliverablesPath = deliverablesDir(repoPath, deliverablesSubdir);
|
|
const logger = createActivityLogger();
|
|
logger.info(`Restoring deliverables to ${checkpointHash}...`);
|
|
|
|
// Validate the hash exists in the deliverables clone (the repo actually being
|
|
// reset below) before attempting reset.
|
|
try {
|
|
await executeGitCommandWithRetry(
|
|
['git', 'cat-file', '-e', `${checkpointHash}^{commit}`],
|
|
deliverablesPath,
|
|
'verify checkpoint hash exists',
|
|
);
|
|
} catch {
|
|
logger.info(`Checkpoint hash not found in clone, skipping git reset: ${checkpointHash}`);
|
|
return;
|
|
}
|
|
|
|
await executeGitCommandWithRetry(
|
|
['git', 'reset', '--hard', checkpointHash],
|
|
deliverablesPath,
|
|
'reset deliverables to checkpoint',
|
|
);
|
|
|
|
// Scope the untracked clean so a completed agent's deliverables survive: exclude every
|
|
// completed agent's paths, cleaning only leftovers from the incomplete agents being re-run.
|
|
const incompleteSet = new Set<AgentName>(incompleteAgents);
|
|
const completedPaths = ALL_AGENTS.filter((name) => !incompleteSet.has(name)).flatMap(getAgentGitPaths);
|
|
const cleanArgs = ['git', 'clean', '-fd', ...completedPaths.flatMap((completedPath) => ['-e', completedPath])];
|
|
await executeGitCommandWithRetry(cleanArgs, deliverablesPath, 'clean untracked deliverables');
|
|
|
|
// Explicitly delete partial deliverables for incomplete agents
|
|
for (const agentName of incompleteAgents) {
|
|
const deliverableFilename = AGENTS[agentName].deliverableFilename;
|
|
const deliverablePath = path.join(deliverablesPath, deliverableFilename);
|
|
try {
|
|
const exists = await fileExists(deliverablePath);
|
|
if (exists) {
|
|
logger.warn(`Cleaning partial deliverable: ${agentName}`);
|
|
await fs.unlink(deliverablePath);
|
|
}
|
|
} catch (error) {
|
|
logger.info(`Note: Failed to delete ${deliverablePath}: ${error}`);
|
|
}
|
|
}
|
|
|
|
logger.info('Deliverables restored to clean state');
|
|
}
|
|
|
|
/**
|
|
* Record a resume attempt in session.json and write resume header to workflow.log.
|
|
*/
|
|
export async function recordResumeAttempt(
|
|
input: ActivityInput,
|
|
terminatedWorkflows: string[],
|
|
checkpointHash: string,
|
|
previousWorkflowId: string,
|
|
completedAgents: string[],
|
|
): Promise<void> {
|
|
const sessionMetadata = buildSessionMetadata(input);
|
|
const auditSession = new AuditSession(sessionMetadata);
|
|
await auditSession.initialize();
|
|
|
|
// Update session.json with resume attempt
|
|
await auditSession.addResumeAttempt(input.workflowId, terminatedWorkflows, checkpointHash);
|
|
|
|
// Write resume header to workflow.log
|
|
await auditSession.logResumeHeader({
|
|
previousWorkflowId,
|
|
newWorkflowId: input.workflowId,
|
|
checkpointHash,
|
|
completedAgents,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Log phase transition to the unified workflow log.
|
|
*/
|
|
export async function logPhaseTransition(
|
|
input: ActivityInput,
|
|
phase: string,
|
|
event: 'start' | 'complete',
|
|
): Promise<void> {
|
|
const sessionMetadata = buildSessionMetadata(input);
|
|
const auditSession = new AuditSession(sessionMetadata);
|
|
await auditSession.initialize(input.workflowId);
|
|
|
|
if (event === 'start') {
|
|
await auditSession.logPhaseStart(phase);
|
|
} else {
|
|
await auditSession.logPhaseComplete(phase);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Log workflow completion with full summary.
|
|
* Cleans up container when done.
|
|
*/
|
|
export async function logWorkflowComplete(input: ActivityInput, summary: WorkflowSummary): Promise<void> {
|
|
const { workflowId } = input;
|
|
const sessionMetadata = buildSessionMetadata(input);
|
|
|
|
// 1. Initialize audit session and mark final status
|
|
const auditSession = new AuditSession(sessionMetadata);
|
|
await auditSession.initialize(workflowId);
|
|
await auditSession.updateSessionStatus(summary.status);
|
|
|
|
// 2. Load cumulative metrics from session.json
|
|
const sessionData = (await auditSession.getMetrics()) as {
|
|
metrics: {
|
|
total_duration_ms: number;
|
|
total_cost_usd: number;
|
|
agents: Record<string, { final_duration_ms: number; total_cost_usd: number }>;
|
|
};
|
|
};
|
|
|
|
// 3. Fill in metrics for skipped agents (resumed from previous run)
|
|
const agentMetrics = { ...summary.agentMetrics };
|
|
for (const agentName of summary.completedAgents) {
|
|
if (!agentMetrics[agentName]) {
|
|
const agentData = sessionData.metrics.agents[agentName];
|
|
if (agentData) {
|
|
agentMetrics[agentName] = {
|
|
durationMs: agentData.final_duration_ms,
|
|
costUsd: agentData.total_cost_usd,
|
|
};
|
|
}
|
|
}
|
|
}
|
|
|
|
// 4. Build cumulative summary with cross-run totals
|
|
const cumulativeSummary: WorkflowSummary = {
|
|
...summary,
|
|
totalDurationMs: sessionData.metrics.total_duration_ms,
|
|
totalCostUsd: sessionData.metrics.total_cost_usd,
|
|
agentMetrics,
|
|
};
|
|
|
|
// 5. Write completion entry to workflow.log
|
|
await auditSession.logWorkflowComplete(cumulativeSummary);
|
|
|
|
// 6. Surface the final report at the run root. Done here (not in the report phase)
|
|
// so it also runs when a resume skips an already-complete report phase. A partial
|
|
// run still assembles a report (only some classes were not assessed), so surface it too.
|
|
if (summary.status === 'completed' || summary.status === 'partial') {
|
|
try {
|
|
await copyReportToRunRoot(
|
|
input.repoPath,
|
|
input.deliverablesSubdir,
|
|
generateAuditPath(sessionMetadata),
|
|
createActivityLogger(),
|
|
);
|
|
} catch (error) {
|
|
const detail = error instanceof Error ? error.message : String(error);
|
|
console.warn(`Failed to surface report at run root: ${detail}`);
|
|
}
|
|
}
|
|
|
|
// 7. Drop the authenticated browser session
|
|
try {
|
|
await fs.rm(authStateFile(sessionMetadata), { force: true });
|
|
} catch (error) {
|
|
const detail = error instanceof Error ? error.message : String(error);
|
|
console.warn(`Failed to clean up auth-state.json: ${detail}`);
|
|
}
|
|
|
|
// 8. Clean up container
|
|
removeContainer(workflowId);
|
|
}
|
|
|
|
/**
|
|
* Merge external findings into the exploitation queue for a vulnerability type.
|
|
*
|
|
* Delegates to the FindingsProvider registered in the DI container.
|
|
* Default: no-op returning { mergedCount: 0 }.
|
|
* Consumers can override this activity at the worker level with custom findings integration.
|
|
*/
|
|
export async function mergeFindingsIntoQueue(
|
|
input: ActivityInput,
|
|
vulnType: VulnType,
|
|
): Promise<{ mergedCount: number }> {
|
|
const container = getContainer(input.workflowId);
|
|
if (!container?.findingsProvider) return { mergedCount: 0 };
|
|
return container.findingsProvider.mergeFindingsIntoQueue(input.repoPath, vulnType, input);
|
|
}
|
|
|
|
/**
|
|
* Persist pipeline state after an agent completes.
|
|
*
|
|
* Delegates to the CheckpointProvider registered in the DI container.
|
|
* Default: no-op. Consumers can override this activity at the worker level with custom persistence.
|
|
*/
|
|
export async function saveCheckpoint(
|
|
input: ActivityInput,
|
|
agentName: string,
|
|
phase: string,
|
|
state: PipelineState,
|
|
): Promise<void> {
|
|
const container = getContainer(input.workflowId);
|
|
if (!container?.checkpointProvider) return;
|
|
|
|
const context: CheckpointContext = {
|
|
repoPath: input.repoPath,
|
|
sessionId: input.sessionId,
|
|
deliverablesSubdir: input.deliverablesSubdir ?? DEFAULT_DELIVERABLES_SUBDIR,
|
|
...(input.outputPath !== undefined && { outputPath: input.outputPath }),
|
|
};
|
|
|
|
return container.checkpointProvider.onAgentComplete(agentName, phase, state, context);
|
|
}
|
|
|
|
/**
|
|
* Generate an optional additional output alongside the assembled markdown report.
|
|
*
|
|
* Delegates to the ReportOutputProvider registered in the DI container.
|
|
* Default: no-op. Consumers can override this activity at the worker level
|
|
* to emit derived outputs from the final report.
|
|
*/
|
|
export async function generateReportOutputActivity(input: ActivityInput): Promise<void> {
|
|
const container = getContainer(input.workflowId);
|
|
if (!container?.reportOutputProvider) return;
|
|
|
|
const logger = createActivityLogger();
|
|
|
|
const result = await container.reportOutputProvider.generate(input, logger);
|
|
if (result.outputPath) {
|
|
logger.info(`Report output written to ${result.outputPath}`);
|
|
}
|
|
}
|