mirror of
https://github.com/khoaliber/dockhand.git
synced 2026-03-05 21:29:04 +00:00
Initial commit
This commit is contained in:
829
lib/server/scanner.ts
Normal file
829
lib/server/scanner.ts
Normal file
@@ -0,0 +1,829 @@
|
||||
// Vulnerability Scanner Service
|
||||
// Supports Grype and Trivy scanners
|
||||
// Uses long-running containers for faster subsequent scans (cached vulnerability databases)
|
||||
|
||||
import {
|
||||
listImages,
|
||||
pullImage,
|
||||
createVolume,
|
||||
listVolumes,
|
||||
removeVolume,
|
||||
runContainer,
|
||||
runContainerWithStreaming,
|
||||
inspectImage
|
||||
} from './docker';
|
||||
import { getEnvironment, getEnvSetting, getSetting } from './db';
|
||||
import { sendEventNotification } from './notifications';
|
||||
|
||||
export type ScannerType = 'none' | 'grype' | 'trivy' | 'both';
|
||||
|
||||
/**
|
||||
* Send vulnerability notifications based on scan results.
|
||||
* Sends the most severe notification type based on found vulnerabilities.
|
||||
*/
|
||||
export async function sendVulnerabilityNotifications(
|
||||
imageName: string,
|
||||
summary: VulnerabilitySeverity,
|
||||
envId?: number
|
||||
): Promise<void> {
|
||||
const totalVulns = summary.critical + summary.high + summary.medium + summary.low + summary.negligible + summary.unknown;
|
||||
|
||||
if (totalVulns === 0) {
|
||||
// No vulnerabilities found, no notification needed
|
||||
return;
|
||||
}
|
||||
|
||||
// Send notifications based on severity (most severe first)
|
||||
// Note: Users can subscribe to specific severity levels, so we send all applicable
|
||||
if (summary.critical > 0) {
|
||||
await sendEventNotification('vulnerability_critical', {
|
||||
title: 'Critical vulnerabilities found',
|
||||
message: `Image "${imageName}" has ${summary.critical} critical vulnerabilities (${totalVulns} total)`,
|
||||
type: 'error'
|
||||
}, envId);
|
||||
}
|
||||
|
||||
if (summary.high > 0) {
|
||||
await sendEventNotification('vulnerability_high', {
|
||||
title: 'High severity vulnerabilities found',
|
||||
message: `Image "${imageName}" has ${summary.high} high severity vulnerabilities (${totalVulns} total)`,
|
||||
type: 'warning'
|
||||
}, envId);
|
||||
}
|
||||
|
||||
// Only send 'any' notification if there are medium/low/negligible but no critical/high
|
||||
// This prevents notification spam for users who only want to know about lesser severities
|
||||
if (summary.critical === 0 && summary.high === 0 && totalVulns > 0) {
|
||||
await sendEventNotification('vulnerability_any', {
|
||||
title: 'Vulnerabilities found',
|
||||
message: `Image "${imageName}" has ${totalVulns} vulnerabilities (medium: ${summary.medium}, low: ${summary.low})`,
|
||||
type: 'info'
|
||||
}, envId);
|
||||
}
|
||||
}
|
||||
|
||||
// Volume names for scanner database caching
|
||||
const GRYPE_VOLUME_NAME = 'dockhand-grype-db';
|
||||
const TRIVY_VOLUME_NAME = 'dockhand-trivy-db';
|
||||
|
||||
// Track running scanner instances to detect concurrent scans
|
||||
const runningScanners = new Map<string, number>(); // key: "grype" or "trivy", value: count
|
||||
|
||||
// Default CLI arguments for scanners (image name is substituted for {image})
|
||||
export const DEFAULT_GRYPE_ARGS = '-o json -v {image}';
|
||||
export const DEFAULT_TRIVY_ARGS = 'image --format json {image}';
|
||||
|
||||
export interface VulnerabilitySeverity {
|
||||
critical: number;
|
||||
high: number;
|
||||
medium: number;
|
||||
low: number;
|
||||
negligible: number;
|
||||
unknown: number;
|
||||
}
|
||||
|
||||
export interface Vulnerability {
|
||||
id: string;
|
||||
severity: string;
|
||||
package: string;
|
||||
version: string;
|
||||
fixedVersion?: string;
|
||||
description?: string;
|
||||
link?: string;
|
||||
scanner: 'grype' | 'trivy';
|
||||
}
|
||||
|
||||
export interface ScanResult {
|
||||
imageId: string;
|
||||
imageName: string;
|
||||
scanner: 'grype' | 'trivy';
|
||||
scannedAt: string;
|
||||
vulnerabilities: Vulnerability[];
|
||||
summary: VulnerabilitySeverity;
|
||||
scanDuration: number;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
export interface ScanProgress {
|
||||
stage: 'checking' | 'pulling-scanner' | 'scanning' | 'parsing' | 'complete' | 'error';
|
||||
message: string;
|
||||
scanner?: 'grype' | 'trivy';
|
||||
progress?: number;
|
||||
result?: ScanResult;
|
||||
results?: ScanResult[]; // All scanner results when using 'both'
|
||||
error?: string;
|
||||
output?: string; // Line of scanner output
|
||||
}
|
||||
|
||||
// Get global default scanner CLI args from general settings (or fallback to hardcoded defaults)
|
||||
export async function getGlobalScannerDefaults(): Promise<{
|
||||
grypeArgs: string;
|
||||
trivyArgs: string;
|
||||
}> {
|
||||
const [grypeArgs, trivyArgs] = await Promise.all([
|
||||
getSetting('default_grype_args'),
|
||||
getSetting('default_trivy_args')
|
||||
]);
|
||||
return {
|
||||
grypeArgs: grypeArgs ?? DEFAULT_GRYPE_ARGS,
|
||||
trivyArgs: trivyArgs ?? DEFAULT_TRIVY_ARGS
|
||||
};
|
||||
}
|
||||
|
||||
// Get scanner settings (scanner type is per-environment, CLI args are global)
|
||||
export async function getScannerSettings(envId?: number): Promise<{
|
||||
scanner: ScannerType;
|
||||
grypeArgs: string;
|
||||
trivyArgs: string;
|
||||
}> {
|
||||
// CLI args are always global - no need for per-env settings
|
||||
const [globalDefaults, scanner] = await Promise.all([
|
||||
getGlobalScannerDefaults(),
|
||||
getEnvSetting('vulnerability_scanner', envId)
|
||||
]);
|
||||
|
||||
return {
|
||||
scanner: scanner || 'none',
|
||||
grypeArgs: globalDefaults.grypeArgs,
|
||||
trivyArgs: globalDefaults.trivyArgs
|
||||
};
|
||||
}
|
||||
|
||||
// Optimized version that accepts pre-cached global defaults (avoids redundant DB calls)
|
||||
// Only looks up scanner type per-environment since CLI args are global
|
||||
export async function getScannerSettingsWithDefaults(
|
||||
envId: number | undefined,
|
||||
globalDefaults: { grypeArgs: string; trivyArgs: string }
|
||||
): Promise<{
|
||||
scanner: ScannerType;
|
||||
grypeArgs: string;
|
||||
trivyArgs: string;
|
||||
}> {
|
||||
const scanner = await getEnvSetting('vulnerability_scanner', envId) || 'none';
|
||||
return {
|
||||
scanner,
|
||||
grypeArgs: globalDefaults.grypeArgs,
|
||||
trivyArgs: globalDefaults.trivyArgs
|
||||
};
|
||||
}
|
||||
|
||||
// Parse CLI args string into array, substituting {image} placeholder
|
||||
function parseCliArgs(argsString: string, imageName: string): string[] {
|
||||
// Replace {image} placeholder with actual image name
|
||||
const withImage = argsString.replace(/\{image\}/g, imageName);
|
||||
// Split by whitespace, respecting quoted strings
|
||||
const args: string[] = [];
|
||||
let current = '';
|
||||
let inQuote = false;
|
||||
let quoteChar = '';
|
||||
|
||||
for (const char of withImage) {
|
||||
if ((char === '"' || char === "'") && !inQuote) {
|
||||
inQuote = true;
|
||||
quoteChar = char;
|
||||
} else if (char === quoteChar && inQuote) {
|
||||
inQuote = false;
|
||||
quoteChar = '';
|
||||
} else if (char === ' ' && !inQuote) {
|
||||
if (current) {
|
||||
args.push(current);
|
||||
current = '';
|
||||
}
|
||||
} else {
|
||||
current += char;
|
||||
}
|
||||
}
|
||||
if (current) {
|
||||
args.push(current);
|
||||
}
|
||||
return args;
|
||||
}
|
||||
|
||||
// Check if a scanner image is available locally
|
||||
async function isScannerImageAvailable(scannerImage: string, envId?: number): Promise<boolean> {
|
||||
try {
|
||||
const images = await listImages(envId);
|
||||
return images.some((img) =>
|
||||
img.tags?.some((tag: string) => tag.includes(scannerImage.split(':')[0]))
|
||||
);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// Pull scanner image if not available
|
||||
async function ensureScannerImage(
|
||||
scannerImage: string,
|
||||
envId?: number,
|
||||
onProgress?: (progress: ScanProgress) => void
|
||||
): Promise<boolean> {
|
||||
const isAvailable = await isScannerImageAvailable(scannerImage, envId);
|
||||
|
||||
if (isAvailable) {
|
||||
return true;
|
||||
}
|
||||
|
||||
onProgress?.({
|
||||
stage: 'pulling-scanner',
|
||||
message: `Pulling scanner image ${scannerImage}...`
|
||||
});
|
||||
|
||||
try {
|
||||
await pullImage(scannerImage, undefined, envId);
|
||||
return true;
|
||||
} catch (error) {
|
||||
console.error(`Failed to pull scanner image ${scannerImage}:`, error);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse Grype JSON output
|
||||
function parseGrypeOutput(output: string): { vulnerabilities: Vulnerability[]; summary: VulnerabilitySeverity } {
|
||||
const vulnerabilities: Vulnerability[] = [];
|
||||
const summary: VulnerabilitySeverity = {
|
||||
critical: 0,
|
||||
high: 0,
|
||||
medium: 0,
|
||||
low: 0,
|
||||
negligible: 0,
|
||||
unknown: 0
|
||||
};
|
||||
|
||||
console.log('[Grype] Raw output length:', output.length);
|
||||
console.log('[Grype] Output starts with:', output.slice(0, 200));
|
||||
|
||||
try {
|
||||
const data = JSON.parse(output);
|
||||
console.log('[Grype] Parsed JSON, matches count:', data.matches?.length || 0);
|
||||
|
||||
if (data.matches) {
|
||||
for (const match of data.matches) {
|
||||
const severity = (match.vulnerability?.severity || 'Unknown').toLowerCase();
|
||||
const vuln: Vulnerability = {
|
||||
id: match.vulnerability?.id || 'Unknown',
|
||||
severity: severity,
|
||||
package: match.artifact?.name || 'Unknown',
|
||||
version: match.artifact?.version || 'Unknown',
|
||||
fixedVersion: match.vulnerability?.fix?.versions?.[0],
|
||||
description: match.vulnerability?.description,
|
||||
link: match.vulnerability?.dataSource,
|
||||
scanner: 'grype'
|
||||
};
|
||||
vulnerabilities.push(vuln);
|
||||
|
||||
// Count by severity
|
||||
if (severity === 'critical') summary.critical++;
|
||||
else if (severity === 'high') summary.high++;
|
||||
else if (severity === 'medium') summary.medium++;
|
||||
else if (severity === 'low') summary.low++;
|
||||
else if (severity === 'negligible') summary.negligible++;
|
||||
else summary.unknown++;
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('[Grype] Failed to parse output:', error);
|
||||
console.error('[Grype] Output was:', output.slice(0, 500));
|
||||
// Check if output looks like an error message from grype
|
||||
const firstLine = output.split('\n')[0].trim();
|
||||
if (firstLine && !firstLine.startsWith('{')) {
|
||||
throw new Error(`Scanner output error: ${firstLine}`);
|
||||
}
|
||||
throw new Error('Failed to parse scanner output - ensure CLI args include "-o json"');
|
||||
}
|
||||
|
||||
console.log('[Grype] Parsed vulnerabilities:', vulnerabilities.length);
|
||||
return { vulnerabilities, summary };
|
||||
}
|
||||
|
||||
// Parse Trivy JSON output
|
||||
function parseTrivyOutput(output: string): { vulnerabilities: Vulnerability[]; summary: VulnerabilitySeverity } {
|
||||
const vulnerabilities: Vulnerability[] = [];
|
||||
const summary: VulnerabilitySeverity = {
|
||||
critical: 0,
|
||||
high: 0,
|
||||
medium: 0,
|
||||
low: 0,
|
||||
negligible: 0,
|
||||
unknown: 0
|
||||
};
|
||||
|
||||
try {
|
||||
const data = JSON.parse(output);
|
||||
|
||||
const results = data.Results || [];
|
||||
for (const result of results) {
|
||||
const vulns = result.Vulnerabilities || [];
|
||||
for (const v of vulns) {
|
||||
const severity = (v.Severity || 'Unknown').toLowerCase();
|
||||
const vuln: Vulnerability = {
|
||||
id: v.VulnerabilityID || 'Unknown',
|
||||
severity: severity,
|
||||
package: v.PkgName || 'Unknown',
|
||||
version: v.InstalledVersion || 'Unknown',
|
||||
fixedVersion: v.FixedVersion,
|
||||
description: v.Description,
|
||||
link: v.PrimaryURL || v.References?.[0],
|
||||
scanner: 'trivy'
|
||||
};
|
||||
vulnerabilities.push(vuln);
|
||||
|
||||
// Count by severity
|
||||
if (severity === 'critical') summary.critical++;
|
||||
else if (severity === 'high') summary.high++;
|
||||
else if (severity === 'medium') summary.medium++;
|
||||
else if (severity === 'low') summary.low++;
|
||||
else if (severity === 'negligible') summary.negligible++;
|
||||
else summary.unknown++;
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('[Trivy] Failed to parse output:', error);
|
||||
console.error('[Trivy] Output was:', output.slice(0, 500));
|
||||
// Check if output looks like an error message from trivy
|
||||
const firstLine = output.split('\n')[0].trim();
|
||||
if (firstLine && !firstLine.startsWith('{')) {
|
||||
throw new Error(`Scanner output error: ${firstLine}`);
|
||||
}
|
||||
throw new Error('Failed to parse scanner output - ensure CLI args include "--format json"');
|
||||
}
|
||||
|
||||
return { vulnerabilities, summary };
|
||||
}
|
||||
|
||||
// Get the SHA256 image ID for a given image name/tag
|
||||
async function getImageSha(imageName: string, envId?: number): Promise<string> {
|
||||
try {
|
||||
const imageInfo = await inspectImage(imageName, envId) as any;
|
||||
// The Id field contains the full sha256:... hash
|
||||
return imageInfo.Id || imageName;
|
||||
} catch {
|
||||
// If we can't inspect the image, fall back to the name
|
||||
return imageName;
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure a named volume exists for caching scanner databases
|
||||
async function ensureVolume(volumeName: string, envId?: number): Promise<void> {
|
||||
const volumes = await listVolumes(envId);
|
||||
const exists = volumes.some(v => v.name === volumeName);
|
||||
if (!exists) {
|
||||
console.log(`[Scanner] Creating database volume: ${volumeName}`);
|
||||
await createVolume({ name: volumeName }, envId);
|
||||
} else {
|
||||
console.log(`[Scanner] Using existing database volume: ${volumeName}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Run scanner in a fresh container with volume-cached database
|
||||
async function runScannerContainer(
|
||||
scannerImage: string,
|
||||
scannerType: 'grype' | 'trivy',
|
||||
imageName: string,
|
||||
cmd: string[],
|
||||
envId?: number,
|
||||
onOutput?: (line: string) => void
|
||||
): Promise<string> {
|
||||
// Ensure database cache volume exists
|
||||
const volumeName = scannerType === 'grype' ? GRYPE_VOLUME_NAME : TRIVY_VOLUME_NAME;
|
||||
await ensureVolume(volumeName, envId);
|
||||
|
||||
// Check if another scanner of the same type is already running
|
||||
// If so, use a unique cache subdirectory to avoid lock conflicts
|
||||
const currentCount = runningScanners.get(scannerType) || 0;
|
||||
const scanId = currentCount > 0 ? `-${Date.now()}-${Math.random().toString(36).slice(2, 8)}` : '';
|
||||
|
||||
// Increment running counter
|
||||
runningScanners.set(scannerType, currentCount + 1);
|
||||
|
||||
// Configure volume mount based on scanner type
|
||||
// Use a unique subdirectory if another scan is in progress
|
||||
const basePath = scannerType === 'grype' ? '/cache/grype' : '/cache/trivy';
|
||||
const dbPath = scanId ? `${basePath}${scanId}` : basePath;
|
||||
|
||||
const binds = [
|
||||
'/var/run/docker.sock:/var/run/docker.sock:ro',
|
||||
`${volumeName}:${basePath}` // Always mount to base path
|
||||
];
|
||||
|
||||
// Environment variables to ensure scanners use the correct cache path
|
||||
// For concurrent scans, use a unique subdirectory
|
||||
const envVars = scannerType === 'grype'
|
||||
? [`GRYPE_DB_CACHE_DIR=${dbPath}`]
|
||||
: [`TRIVY_CACHE_DIR=${dbPath}`];
|
||||
|
||||
if (scanId) {
|
||||
console.log(`[Scanner] Concurrent scan detected - using unique cache dir: ${dbPath}`);
|
||||
}
|
||||
console.log(`[Scanner] Running ${scannerType} with volume ${volumeName} mounted at ${basePath}`);
|
||||
|
||||
try {
|
||||
// Run the scanner container
|
||||
const output = await runContainerWithStreaming({
|
||||
image: scannerImage,
|
||||
cmd,
|
||||
binds,
|
||||
env: envVars,
|
||||
name: `dockhand-${scannerType}-${Date.now()}`,
|
||||
envId,
|
||||
onStderr: (data) => {
|
||||
// Stream stderr lines for real-time progress output
|
||||
const lines = data.split('\n');
|
||||
for (const line of lines) {
|
||||
if (line.trim()) {
|
||||
onOutput?.(line);
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
return output;
|
||||
} finally {
|
||||
// Decrement running counter
|
||||
const newCount = (runningScanners.get(scannerType) || 1) - 1;
|
||||
if (newCount <= 0) {
|
||||
runningScanners.delete(scannerType);
|
||||
} else {
|
||||
runningScanners.set(scannerType, newCount);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Scan image with Grype
|
||||
export async function scanWithGrype(
|
||||
imageName: string,
|
||||
envId?: number,
|
||||
onProgress?: (progress: ScanProgress) => void
|
||||
): Promise<ScanResult> {
|
||||
const startTime = Date.now();
|
||||
const scannerImage = 'anchore/grype:latest';
|
||||
const { grypeArgs } = await getScannerSettings(envId);
|
||||
|
||||
onProgress?.({
|
||||
stage: 'checking',
|
||||
message: 'Checking Grype scanner availability...',
|
||||
scanner: 'grype'
|
||||
});
|
||||
|
||||
// Ensure scanner image is available
|
||||
const available = await ensureScannerImage(scannerImage, envId, onProgress);
|
||||
if (!available) {
|
||||
throw new Error('Failed to get Grype scanner image. Please ensure Docker can pull images.');
|
||||
}
|
||||
|
||||
onProgress?.({
|
||||
stage: 'scanning',
|
||||
message: `Scanning ${imageName} with Grype...`,
|
||||
scanner: 'grype',
|
||||
progress: 30
|
||||
});
|
||||
|
||||
try {
|
||||
// Parse CLI args from settings
|
||||
const cmd = parseCliArgs(grypeArgs, imageName);
|
||||
const output = await runScannerContainer(
|
||||
scannerImage,
|
||||
'grype',
|
||||
imageName,
|
||||
cmd,
|
||||
envId,
|
||||
(line) => {
|
||||
onProgress?.({
|
||||
stage: 'scanning',
|
||||
message: `Scanning ${imageName} with Grype...`,
|
||||
scanner: 'grype',
|
||||
progress: 50,
|
||||
output: line
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
onProgress?.({
|
||||
stage: 'parsing',
|
||||
message: 'Parsing scan results...',
|
||||
scanner: 'grype',
|
||||
progress: 80
|
||||
});
|
||||
|
||||
const { vulnerabilities, summary } = parseGrypeOutput(output);
|
||||
|
||||
// Get the actual SHA256 image ID for reliable caching
|
||||
const imageId = await getImageSha(imageName, envId);
|
||||
|
||||
const result: ScanResult = {
|
||||
imageId,
|
||||
imageName,
|
||||
scanner: 'grype',
|
||||
scannedAt: new Date().toISOString(),
|
||||
vulnerabilities,
|
||||
summary,
|
||||
scanDuration: Date.now() - startTime
|
||||
};
|
||||
|
||||
onProgress?.({
|
||||
stage: 'complete',
|
||||
message: 'Grype scan complete',
|
||||
scanner: 'grype',
|
||||
progress: 100,
|
||||
result
|
||||
});
|
||||
|
||||
return result;
|
||||
} catch (error) {
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
onProgress?.({
|
||||
stage: 'error',
|
||||
message: `Grype scan failed: ${errorMsg}`,
|
||||
scanner: 'grype',
|
||||
error: errorMsg
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
// Scan image with Trivy
|
||||
export async function scanWithTrivy(
|
||||
imageName: string,
|
||||
envId?: number,
|
||||
onProgress?: (progress: ScanProgress) => void
|
||||
): Promise<ScanResult> {
|
||||
const startTime = Date.now();
|
||||
const scannerImage = 'aquasec/trivy:latest';
|
||||
const { trivyArgs } = await getScannerSettings(envId);
|
||||
|
||||
onProgress?.({
|
||||
stage: 'checking',
|
||||
message: 'Checking Trivy scanner availability...',
|
||||
scanner: 'trivy'
|
||||
});
|
||||
|
||||
// Ensure scanner image is available
|
||||
const available = await ensureScannerImage(scannerImage, envId, onProgress);
|
||||
if (!available) {
|
||||
throw new Error('Failed to get Trivy scanner image. Please ensure Docker can pull images.');
|
||||
}
|
||||
|
||||
onProgress?.({
|
||||
stage: 'scanning',
|
||||
message: `Scanning ${imageName} with Trivy...`,
|
||||
scanner: 'trivy',
|
||||
progress: 30
|
||||
});
|
||||
|
||||
try {
|
||||
// Parse CLI args from settings
|
||||
const cmd = parseCliArgs(trivyArgs, imageName);
|
||||
const output = await runScannerContainer(
|
||||
scannerImage,
|
||||
'trivy',
|
||||
imageName,
|
||||
cmd,
|
||||
envId,
|
||||
(line) => {
|
||||
onProgress?.({
|
||||
stage: 'scanning',
|
||||
message: `Scanning ${imageName} with Trivy...`,
|
||||
scanner: 'trivy',
|
||||
progress: 50,
|
||||
output: line
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
onProgress?.({
|
||||
stage: 'parsing',
|
||||
message: 'Parsing scan results...',
|
||||
scanner: 'trivy',
|
||||
progress: 80
|
||||
});
|
||||
|
||||
const { vulnerabilities, summary } = parseTrivyOutput(output);
|
||||
|
||||
// Get the actual SHA256 image ID for reliable caching
|
||||
const imageId = await getImageSha(imageName, envId);
|
||||
|
||||
const result: ScanResult = {
|
||||
imageId,
|
||||
imageName,
|
||||
scanner: 'trivy',
|
||||
scannedAt: new Date().toISOString(),
|
||||
vulnerabilities,
|
||||
summary,
|
||||
scanDuration: Date.now() - startTime
|
||||
};
|
||||
|
||||
onProgress?.({
|
||||
stage: 'complete',
|
||||
message: 'Trivy scan complete',
|
||||
scanner: 'trivy',
|
||||
progress: 100,
|
||||
result
|
||||
});
|
||||
|
||||
return result;
|
||||
} catch (error) {
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
onProgress?.({
|
||||
stage: 'error',
|
||||
message: `Trivy scan failed: ${errorMsg}`,
|
||||
scanner: 'trivy',
|
||||
error: errorMsg
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
// Scan image with configured scanner(s)
|
||||
export async function scanImage(
|
||||
imageName: string,
|
||||
envId?: number,
|
||||
onProgress?: (progress: ScanProgress) => void,
|
||||
forceScannerType?: ScannerType
|
||||
): Promise<ScanResult[]> {
|
||||
const { scanner } = await getScannerSettings(envId);
|
||||
const scannerType = forceScannerType || scanner;
|
||||
|
||||
if (scannerType === 'none') {
|
||||
return [];
|
||||
}
|
||||
|
||||
const results: ScanResult[] = [];
|
||||
|
||||
const errors: Error[] = [];
|
||||
|
||||
if (scannerType === 'grype' || scannerType === 'both') {
|
||||
try {
|
||||
const result = await scanWithGrype(imageName, envId, onProgress);
|
||||
results.push(result);
|
||||
} catch (error) {
|
||||
console.error('Grype scan failed:', error);
|
||||
errors.push(error instanceof Error ? error : new Error(String(error)));
|
||||
if (scannerType === 'grype') throw error;
|
||||
}
|
||||
}
|
||||
|
||||
if (scannerType === 'trivy' || scannerType === 'both') {
|
||||
try {
|
||||
const result = await scanWithTrivy(imageName, envId, onProgress);
|
||||
results.push(result);
|
||||
} catch (error) {
|
||||
console.error('Trivy scan failed:', error);
|
||||
errors.push(error instanceof Error ? error : new Error(String(error)));
|
||||
if (scannerType === 'trivy') throw error;
|
||||
}
|
||||
}
|
||||
|
||||
// If using 'both' and all scanners failed, throw an error
|
||||
if (scannerType === 'both' && results.length === 0 && errors.length > 0) {
|
||||
throw new Error(`All scanners failed: ${errors.map(e => e.message).join('; ')}`);
|
||||
}
|
||||
|
||||
// Send vulnerability notifications based on combined results
|
||||
// When using 'both' scanners, take the MAX of each severity across all results
|
||||
if (results.length > 0) {
|
||||
const combinedSummary: VulnerabilitySeverity = {
|
||||
critical: Math.max(...results.map(r => r.summary.critical)),
|
||||
high: Math.max(...results.map(r => r.summary.high)),
|
||||
medium: Math.max(...results.map(r => r.summary.medium)),
|
||||
low: Math.max(...results.map(r => r.summary.low)),
|
||||
negligible: Math.max(...results.map(r => r.summary.negligible)),
|
||||
unknown: Math.max(...results.map(r => r.summary.unknown))
|
||||
};
|
||||
|
||||
// Send notifications (async, don't block return)
|
||||
sendVulnerabilityNotifications(imageName, combinedSummary, envId).catch(err => {
|
||||
console.error('[Scanner] Failed to send vulnerability notifications:', err);
|
||||
});
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
// Check if scanner images are available
|
||||
export async function checkScannerAvailability(envId?: number): Promise<{
|
||||
grype: boolean;
|
||||
trivy: boolean;
|
||||
}> {
|
||||
const [grypeAvailable, trivyAvailable] = await Promise.all([
|
||||
isScannerImageAvailable('anchore/grype', envId),
|
||||
isScannerImageAvailable('aquasec/trivy', envId)
|
||||
]);
|
||||
|
||||
return {
|
||||
grype: grypeAvailable,
|
||||
trivy: trivyAvailable
|
||||
};
|
||||
}
|
||||
|
||||
// Get scanner version by running a temporary container
|
||||
async function getScannerVersion(
|
||||
scannerType: 'grype' | 'trivy',
|
||||
envId?: number
|
||||
): Promise<string | null> {
|
||||
try {
|
||||
const scannerImage = scannerType === 'grype' ? 'anchore/grype:latest' : 'aquasec/trivy:latest';
|
||||
|
||||
// Check if image exists first
|
||||
const images = await listImages(envId);
|
||||
const hasImage = images.some((img) =>
|
||||
img.tags?.some((tag: string) => tag.includes(scannerImage.split(':')[0]))
|
||||
);
|
||||
if (!hasImage) return null;
|
||||
|
||||
// Create temporary container to get version
|
||||
const versionCmd = scannerType === 'grype' ? ['version'] : ['--version'];
|
||||
const { stdout, stderr } = await runContainer({
|
||||
image: scannerImage,
|
||||
cmd: versionCmd,
|
||||
name: `dockhand-${scannerType}-version-${Date.now()}`,
|
||||
envId
|
||||
});
|
||||
|
||||
const output = stdout || stderr;
|
||||
|
||||
// Parse version from output
|
||||
// Grype: "grype 0.74.0" or "Application: grype\nVersion: 0.86.1"
|
||||
// Trivy: "Version: 0.48.0" or just "0.48.0"
|
||||
const versionMatch = output.match(/(?:grype|trivy|Version:?\s*)?([\d]+\.[\d]+\.[\d]+)/i);
|
||||
const version = versionMatch ? versionMatch[1] : null;
|
||||
|
||||
if (!version) {
|
||||
console.error(`Could not parse ${scannerType} version from output:`, output.substring(0, 200));
|
||||
}
|
||||
|
||||
return version;
|
||||
} catch (error) {
|
||||
console.error(`Failed to get ${scannerType} version:`, error);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// Get versions of available scanners
|
||||
export async function getScannerVersions(envId?: number): Promise<{
|
||||
grype: string | null;
|
||||
trivy: string | null;
|
||||
}> {
|
||||
const [grypeVersion, trivyVersion] = await Promise.all([
|
||||
getScannerVersion('grype', envId),
|
||||
getScannerVersion('trivy', envId)
|
||||
]);
|
||||
|
||||
return {
|
||||
grype: grypeVersion,
|
||||
trivy: trivyVersion
|
||||
};
|
||||
}
|
||||
|
||||
// Check if scanner images have updates available by comparing local digest with remote
|
||||
export async function checkScannerUpdates(envId?: number): Promise<{
|
||||
grype: { hasUpdate: boolean; localDigest?: string; remoteDigest?: string };
|
||||
trivy: { hasUpdate: boolean; localDigest?: string; remoteDigest?: string };
|
||||
}> {
|
||||
const result = {
|
||||
grype: { hasUpdate: false, localDigest: undefined as string | undefined, remoteDigest: undefined as string | undefined },
|
||||
trivy: { hasUpdate: false, localDigest: undefined as string | undefined, remoteDigest: undefined as string | undefined }
|
||||
};
|
||||
|
||||
try {
|
||||
const images = await listImages(envId);
|
||||
|
||||
// Check both scanners
|
||||
for (const [scanner, imageName] of [['grype', 'anchore/grype:latest'], ['trivy', 'aquasec/trivy:latest']] as const) {
|
||||
try {
|
||||
// Find local image
|
||||
const localImage = images.find((img) =>
|
||||
img.tags?.includes(imageName)
|
||||
);
|
||||
|
||||
if (localImage) {
|
||||
result[scanner].localDigest = localImage.id?.substring(7, 19); // Short digest
|
||||
// Note: Remote digest checking would require pulling or using registry API
|
||||
// For simplicity, we just note that checking for updates requires a pull
|
||||
result[scanner].hasUpdate = false;
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(`Failed to check updates for ${scanner}:`, error);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Failed to check scanner updates:', error);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
// Clean up scanner database volumes (removes cached vulnerability databases)
|
||||
export async function cleanupScannerVolumes(envId?: number): Promise<void> {
|
||||
try {
|
||||
// Remove scanner database volumes
|
||||
for (const volumeName of [GRYPE_VOLUME_NAME, TRIVY_VOLUME_NAME]) {
|
||||
try {
|
||||
await removeVolume(volumeName, true, envId);
|
||||
console.log(`[Scanner] Removed volume: ${volumeName}`);
|
||||
} catch {
|
||||
// Volume might not exist, ignore
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Failed to cleanup scanner volumes:', error);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user