Skip to content

Modern Docker Management, Designed for Everyone

5.2 KB
Raw Blame
package query

import (
	"net/http"

	"github.com/danielgtaylor/huma/v2"

	"github.com/getarcaneapp/arcane/backend/v2/internal/middleware"
	"github.com/getarcaneapp/arcane/backend/v2/pkg/authz"
	"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
)

// RegisterRoutes registers the vulnerability results and risk endpoints behind featureMiddleware.
func RegisterRoutes(api huma.API, h *Handler, featureMiddleware huma.Middlewares) {
	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "get-image-vulnerabilities",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/images/{imageId}/vulnerabilities",
		Summary:     "Get vulnerability scan result",
		Description: "Retrieves the most recent vulnerability scan result for an image",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.GetScanResult)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "get-image-vulnerability-summary",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/images/{imageId}/vulnerabilities/summary",
		Summary:     "Get vulnerability scan summary",
		Description: "Retrieves just the summary of vulnerabilities for an image (for list views)",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.GetScanSummary)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "get-image-vulnerability-summaries",
		Method:      http.MethodPost,
		Path:        "/environments/{id}/images/vulnerabilities/summaries",
		Summary:     "Get vulnerability scan summaries",
		Description: "Retrieves scan summaries for a list of images (batch)",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.GetScanSummaries)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "list-image-vulnerabilities",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/images/{imageId}/vulnerabilities/list",
		Summary:     "List image vulnerabilities",
		Description: "Retrieves paginated vulnerabilities for an image",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.ListImageVulnerabilities)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "get-environment-vulnerability-summary",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/vulnerabilities/summary",
		Summary:     "Get environment vulnerability summary",
		Description: "Retrieves aggregated vulnerability counts across all images in the environment",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.GetEnvironmentSummary)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "get-environment-vulnerability-overview",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/vulnerabilities/overview",
		Summary:     "Get environment vulnerability risk overview",
		Description: "Retrieves the environment risk score, trend, drivers, riskiest images and priority findings",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.GetRiskOverview)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "list-environment-vulnerabilities",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/vulnerabilities/all",
		Summary:     "List environment vulnerabilities",
		Description: "Retrieves paginated vulnerabilities across all scanned images in the environment",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
		Metadata:    map[string]any{authz.MetaEnvironmentAggregate: true},
	}, authz.PermVulnsRead, h.ListAllVulnerabilities)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "export-environment-vulnerabilities",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/vulnerabilities/export",
		Summary:     "Export environment vulnerabilities",
		Description: "Downloads every vulnerability matching the given filters as a CSV file",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
	}, authz.PermVulnsRead, h.ExportVulnerabilities)

	middleware.RegisterWithPermission(api, huma.Operation{
		Middlewares: featureMiddleware,
		OperationID: "list-environment-vulnerability-image-options",
		Method:      http.MethodGet,
		Path:        "/environments/{id}/vulnerabilities/image-options",
		Summary:     "List vulnerability image options",
		Description: "Retrieves available image filter options for environment vulnerabilities",
		Tags:        []string{"Vulnerabilities"},
		Security:    handlerutil.DefaultOperationSecurity(),
		Metadata:    map[string]any{authz.MetaEnvironmentAggregate: true},
	}, authz.PermVulnsRead, h.ListAllVulnerabilityImageOptions)
}