Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
package scan
import (
"context"
"errors"
"github.com/danielgtaylor/huma/v2"
"github.com/getarcaneapp/arcane/types/v2/base"
"github.com/getarcaneapp/arcane/types/v2/features"
"github.com/getarcaneapp/arcane/types/v2/vulnerability"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
)
// Handler serves the vulnerability scan endpoints.
type Handler struct {
service *Service
appCtx context.Context
}
func NewHandler(service *Service, appCtx context.Context) *Handler {
return &Handler{service: service, appCtx: appCtx}
}
type ScanImageInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
ImageID string `path:"imageId" doc:"Image ID to scan"`
}
// ScanImage initiates a vulnerability scan for an image.
func (h *Handler) ScanImage(ctx context.Context, input *ScanImageInput) (*handlerutil.Out[vulnerability.ScanResult], error) {
user, err := handlerutil.RequireUser(ctx)
if err != nil {
return nil, err
}
runtimeCtx := utils.ActivityRuntimeContext(ctx, h.appCtx)
result, err := h.service.ScanImage(runtimeCtx, input.EnvironmentID, input.ImageID, *user)
if err != nil {
if errors.Is(err, common.ErrFeatureDisabled) {
return nil, handlerutil.FeatureDisabledError(features.VulnerabilityManagement)
}
return nil, huma.NewError(common.ToAPIError(err).HTTPStatus(), "Failed to scan image for vulnerabilities: "+err.Error())
}
return &handlerutil.Out[vulnerability.ScanResult]{
Body: base.ApiResponse[vulnerability.ScanResult]{
Success: true,
Data: *result,
},
}, nil
}