Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
import { environmentStore } from '#lib/stores/environment.store.svelte.js';
import type {
VulnerabilityScanResult,
VulnerabilityScanSummary,
ScanSummariesRequest,
ScanSummariesResponse,
ScannerStatus,
Vulnerability,
VulnerabilityWithImage,
VulnerabilityRiskOverview,
IgnoredVulnerability,
IgnoreVulnerabilityPayload,
BulkVulnerabilityFilters,
BulkVulnerabilityActionResponse
} from '#lib/types/environment.js';
import type { Paginated, SearchPaginationSortRequest } from '#lib/types/shared.js';
import { filenameFromContentDisposition } from '#lib/utils/browser-download.js';
import { transformPaginationParams } from '#lib/utils/tables.js';
import BaseAPIService, { type APIRequestConfig } from './api-service';
class VulnerabilityService extends BaseAPIService {
private async resolveEnvironmentId(environmentId?: string): Promise<string> {
return environmentId ?? (await environmentStore.getCurrentEnvironmentId());
}
/**
* Scan an image for vulnerabilities
*/
async scanImage(imageId: string, environmentId?: string): Promise<VulnerabilityScanResult> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.post(`/environments/${envId}/images/${imageId}/vulnerabilities/scan`));
}
/**
* Get the full vulnerability scan result for an image
*/
async getScanResult(imageId: string, environmentId?: string): Promise<VulnerabilityScanResult> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.get(`/environments/${envId}/images/${imageId}/vulnerabilities`));
}
/**
* Get a paginated list of vulnerabilities for an image
*/
async getImageVulnerabilities(
imageId: string,
options?: SearchPaginationSortRequest,
environmentId?: string
): Promise<Paginated<Vulnerability>> {
const envId = await this.resolveEnvironmentId(environmentId);
const params = transformPaginationParams(options);
const res = await this.api.get(`/environments/${envId}/images/${imageId}/vulnerabilities/list`, { params });
return res.data;
}
/**
* Get just the vulnerability summary for an image (for list views)
*/
async getScanSummary(imageId: string, environmentId?: string): Promise<VulnerabilityScanSummary> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.get(`/environments/${envId}/images/${imageId}/vulnerabilities/summary`));
}
/**
* Get vulnerability scan summaries for multiple images (batch)
*/
async getScanSummaries(imageIds: string[], environmentId?: string): Promise<ScanSummariesResponse> {
const envId = await this.resolveEnvironmentId(environmentId);
const payload: ScanSummariesRequest = { imageIds };
return this.handleResponse(this.api.post(`/environments/${envId}/images/vulnerabilities/summaries`, payload));
}
/**
* Get the scanner status (whether Trivy is available)
*/
async getScannerStatus(environmentId?: string): Promise<ScannerStatus> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.get(`/environments/${envId}/vulnerabilities/scanner-status`));
}
/**
* Get the environment risk overview (score, trend, drivers, riskiest images, priority findings)
*/
async getRiskOverviewForEnvironment(environmentId: string): Promise<VulnerabilityRiskOverview> {
return this.handleResponse(this.api.get(`/environments/${environmentId}/vulnerabilities/overview`));
}
/**
* Get a paginated list of vulnerabilities across all images
*/
async getAllVulnerabilities(options?: SearchPaginationSortRequest): Promise<Paginated<VulnerabilityWithImage>> {
const envId = await this.resolveEnvironmentId();
return this.getAllVulnerabilitiesForEnvironment(envId, options);
}
async getAllVulnerabilitiesForEnvironment(
environmentId: string,
options?: SearchPaginationSortRequest,
config?: APIRequestConfig
): Promise<Paginated<VulnerabilityWithImage>> {
const params = transformPaginationParams(options);
const res = await this.api.get(`/environments/${environmentId}/vulnerabilities/all`, { ...config, params });
return res.data;
}
async exportVulnerabilitiesForEnvironment(
environmentId: string,
options?: SearchPaginationSortRequest
): Promise<{ blob: Blob; filename: string }> {
const params = transformPaginationParams(options);
const res = await this.api.get(`/environments/${environmentId}/vulnerabilities/export`, { params, responseType: 'blob' });
return {
blob: res.data,
filename: filenameFromContentDisposition(res.headers.get('content-disposition'), 'vulnerabilities.csv')
};
}
/**
* Get available image filter options for environment vulnerabilities.
* This endpoint is independent from rows pagination and currently supports severity-only filtering.
*/
async getAllVulnerabilityImageOptions(options?: SearchPaginationSortRequest): Promise<string[]> {
const envId = await this.resolveEnvironmentId();
return this.getAllVulnerabilityImageOptionsForEnvironment(envId, options);
}
async getAllVulnerabilityImageOptionsForEnvironment(
environmentId: string,
options?: SearchPaginationSortRequest,
config?: APIRequestConfig
): Promise<string[]> {
const severityFilter = options?.filters?.['severity'];
const params: Record<string, string> = {};
if (severityFilter !== undefined && severityFilter !== null) {
params['severity'] = Array.isArray(severityFilter) ? severityFilter.join(',') : String(severityFilter);
}
return this.handleResponse(
this.api.get(`/environments/${environmentId}/vulnerabilities/image-options`, { ...config, params })
);
}
/**
* Ignore a vulnerability
*/
async ignoreVulnerability(payload: IgnoreVulnerabilityPayload, environmentId?: string): Promise<IgnoredVulnerability> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.post(`/environments/${envId}/vulnerabilities/ignore`, payload));
}
/**
* Unignore a vulnerability
*/
async unignoreVulnerability(ignoreId: string, environmentId?: string): Promise<void> {
const envId = await this.resolveEnvironmentId(environmentId);
await this.handleResponse(this.api.delete(`/environments/${envId}/vulnerabilities/ignore/${ignoreId}`));
}
async bulkIgnoreVulnerabilities(
filters: BulkVulnerabilityFilters,
environmentId?: string
): Promise<BulkVulnerabilityActionResponse> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.post(`/environments/${envId}/vulnerabilities/ignore/bulk`, filters));
}
async bulkUnignoreVulnerabilities(
filters: BulkVulnerabilityFilters,
environmentId?: string
): Promise<BulkVulnerabilityActionResponse> {
const envId = await this.resolveEnvironmentId(environmentId);
return this.handleResponse(this.api.post(`/environments/${envId}/vulnerabilities/unignore/bulk`, filters));
}
/**
* Get a list of ignored vulnerabilities
*/
async getIgnoredVulnerabilities(
options?: SearchPaginationSortRequest,
environmentId?: string
): Promise<Paginated<IgnoredVulnerability>> {
const envId = await this.resolveEnvironmentId(environmentId);
const params = transformPaginationParams(options);
const res = await this.api.get(`/environments/${envId}/vulnerabilities/ignored`, { params });
return res.data;
}
}
export const vulnerabilityService = new VulnerabilityService();