Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: trivy scans not using arcane registries credentials (#2771)
Kyle Mendell5d29ce30ffc1
diff --git a/backend/internal/bootstrap/services_bootstrap.go b/backend/internal/bootstrap/services_bootstrap.goindex 76463db63..43b259633 100644--- a/backend/internal/bootstrap/services_bootstrap.go+++ b/backend/internal/bootstrap/services_bootstrap.go@@ -79,7 +79,7 @@ func initializeServices(ctx context.Context, db *database.DB, cfg *config.Configsvcs.Environment = services.NewEnvironmentService(db, httpClient, svcs.Docker, svcs.Event, svcs.Settings, svcs.ApiKey)svcs.Version = services.NewVersionService(httpClient, cfg.UpdateCheckDisabled, config.Version, config.Revision, svcs.ContainerRegistry, svcs.Docker)svcs.Notification = services.NewNotificationService(db, cfg, svcs.Environment)- svcs.Vulnerability = services.NewVulnerabilityService(db, svcs.Docker, svcs.Event, svcs.Settings, svcs.Notification, svcs.Activity)+ svcs.Vulnerability = services.NewVulnerabilityService(db, svcs.Docker, svcs.Event, svcs.Settings, svcs.Notification, svcs.Activity, svcs.ContainerRegistry)svcs.ImageUpdate = services.NewImageUpdateService(db, svcs.Settings, svcs.ContainerRegistry, svcs.Docker, svcs.Event, svcs.Notification, svcs.Activity)svcs.Image = services.NewImageService(db, svcs.Docker, svcs.ContainerRegistry, svcs.ImageUpdate, svcs.Vulnerability, svcs.Event)svcs.GitRepository = services.NewGitRepositoryService(db, cfg.GitWorkDir, svcs.Event, svcs.Settings)diff --git a/backend/internal/services/vulnerability_service.go b/backend/internal/services/vulnerability_service.goindex 1e0331a87..28919e4eb 100644--- a/backend/internal/services/vulnerability_service.go+++ b/backend/internal/services/vulnerability_service.go@@ -4,6 +4,7 @@ import ("archive/tar""bytes""context"+ "encoding/base64""encoding/json""errors""fmt"@@ -36,6 +37,7 @@ import (containertypes "github.com/moby/moby/api/types/container"imagetypes "github.com/moby/moby/api/types/image"mounttypes "github.com/moby/moby/api/types/mount"+ dockerregistry "github.com/moby/moby/api/types/registry""github.com/moby/moby/client""gorm.io/gorm""gorm.io/gorm/clause"@@ -66,6 +68,9 @@ const (DefaultTrivyDBRepository = "ghcr.io/getarcaneapp/trivy-db:2"DefaultTrivyJavaDBRepository = "ghcr.io/getarcaneapp/trivy-java-db:1"DefaultTrivyChecksBundleRepository = "ghcr.io/getarcaneapp/trivy-checks:1"+ trivyRegistryConfigDir = "/tmp/arcane-registry-auth"+ trivyRegistryConfigCopyDest = "/tmp"+ trivyRegistryConfigTarName = "arcane-registry-auth/config.json")type trivyRuntimeOptions struct {@@ -82,6 +87,7 @@ type VulnerabilityService struct {settingsService *SettingsServicenotificationService *NotificationServiceactivityService *ActivityService+ registryService *ContainerRegistryService// scanLocks provides per-image locking to allow concurrent scans of different images// while preventing duplicate scans of the same imagescanLocks sync.Map // map[string]*sync.Mutex@@ -233,7 +239,7 @@ func (s *VulnerabilityService) getTrivyScanSlotChannelInternal(limit int) chan i}// NewVulnerabilityService creates a new VulnerabilityService instance-func NewVulnerabilityService(db *database.DB, dockerService *DockerClientService, eventService *EventService, settingsService *SettingsService, notificationService *NotificationService, activityService *ActivityService) *VulnerabilityService {+func NewVulnerabilityService(db *database.DB, dockerService *DockerClientService, eventService *EventService, settingsService *SettingsService, notificationService *NotificationService, activityService *ActivityService, registryService *ContainerRegistryService) *VulnerabilityService {return &VulnerabilityService{db: db,dockerService: dockerService,@@ -241,10 +247,61 @@ func NewVulnerabilityService(db *database.DB, dockerService *DockerClientServicesettingsService: settingsService,notificationService: notificationService,activityService: activityService,+ registryService: registryService,trivyScanSlots: nil,}}+func buildDockerConfigJSONInternal(authConfigs map[string]dockerregistry.AuthConfig) ([]byte, error) {+ if len(authConfigs) == 0 {+ return nil, nil+ }++ type authEntry struct {+ Auth string `json:"auth"`+ }++ auths := make(map[string]authEntry, len(authConfigs))+ for host, cfg := range authConfigs {+ host = strings.TrimSpace(host)+ if host == "" || cfg.Username == "" || cfg.Password == "" {+ continue+ }++ auths[host] = authEntry{+ Auth: base64.StdEncoding.EncodeToString([]byte(cfg.Username + ":" + cfg.Password)),+ }+ }++ if len(auths) == 0 {+ return nil, nil+ }++ return json.Marshal(struct {+ Auths map[string]authEntry `json:"auths"`+ }{Auths: auths})+}++func (s *VulnerabilityService) buildTrivyRegistryConfigInternal(ctx context.Context) []byte {+ if s.registryService == nil {+ return nil+ }++ authConfigs, err := s.registryService.GetAllRegistryAuthConfigs(ctx)+ if err != nil {+ slog.WarnContext(ctx, "failed to load registry credentials for trivy scan; continuing anonymously", "error", err)+ return nil+ }++ configJSON, err := buildDockerConfigJSONInternal(authConfigs)+ if err != nil {+ slog.WarnContext(ctx, "failed to build trivy registry config; continuing anonymously", "error", err)+ return nil+ }++ return configJSON+}+// ScanImage scans an image for vulnerabilities using Trivyfunc (s *VulnerabilityService) ScanImage(ctx context.Context, envID string, imageID string, user models.User) (*vulnerability.ScanResult, error) {scanCtx := utils.ActivityRuntimeContext(ctx, nil)@@ -1438,10 +1495,18 @@ func (s *VulnerabilityService) createBatchTrivyContainer(ctx context.Context, trreturn "", err}+ registryConfigJSON := s.buildTrivyRegistryConfigInternal(ctx)+ env := append([]string(nil), runtimeOptions.ContainerEnv...)+ if len(registryConfigJSON) > 0 {+ env = append(env, "DOCKER_CONFIG="+trivyRegistryConfigDir)+ // ECR tokens are refreshed when the batch container is created; a multi-hour+ // batch could outlive the token and fall back to anonymous pulls.+ }+config := &containertypes.Config{Image: trivyImage,Entrypoint: []string{"sh", "-c", "trap 'exit 0' TERM; while :; do sleep 1; done"},- Env: append([]string(nil), runtimeOptions.ContainerEnv...),+ Env: env,Labels: map[string]string{libarcane.InternalResourceLabel: "true",},@@ -1453,7 +1518,7 @@ func (s *VulnerabilityService) createBatchTrivyContainer(ctx context.Context, trresources, cpuSet, applyLimits := s.getTrivyContainerResourceOptionsInternal(ctx, dockerClient)applyTrivyContainerResourcesInternal(hostConfig, resources, cpuSet, applyLimits)- containerID, err := s.createAndStartTrivyContainerInternal(ctx, dockerClient, "batch", config, hostConfig)+ containerID, err := s.createAndStartTrivyContainerInternal(ctx, dockerClient, "batch", config, hostConfig, registryConfigJSON)if err != nil {return "", err}@@ -2570,12 +2635,46 @@ func removeDockerContainerInternal(ctx context.Context, dockerClient *client.Cli}}+func copyRegistryConfigToContainerInternal(ctx context.Context, dockerClient *client.Client, containerID string, configJSON []byte) error {+ if dockerClient == nil || containerID == "" || len(configJSON) == 0 {+ return nil+ }++ var buf bytes.Buffer+ tw := tar.NewWriter(&buf)++ if err := tw.WriteHeader(&tar.Header{Name: "arcane-registry-auth/", Mode: 0o755, Typeflag: tar.TypeDir}); err != nil {+ return err+ }+ if err := tw.WriteHeader(&tar.Header{Name: trivyRegistryConfigTarName, Mode: 0o644, Size: int64(len(configJSON))}); err != nil {+ _ = tw.Close()+ return err+ }+ if _, err := tw.Write(configJSON); err != nil {+ _ = tw.Close()+ return err+ }+ if err := tw.Close(); err != nil {+ return err+ }++ copyCtx, copyCancel := timeouts.WithTimeout(ctx, 0, timeouts.DefaultDockerAPI)+ defer copyCancel()++ _, err := dockerClient.CopyToContainer(copyCtx, containerID, client.CopyToContainerOptions{+ DestinationPath: trivyRegistryConfigCopyDest,+ Content: &buf,+ })+ return err+}+func (s *VulnerabilityService) createAndStartTrivyContainerInternal(ctx context.Context,dockerClient *client.Client,scope string,config *containertypes.Config,hostConfig *containertypes.HostConfig,+ registryConfigJSON []byte,) (string, error) {logTrivyContainerStartupRequestInternal(ctx, scope, config, hostConfig)@@ -2591,6 +2690,19 @@ func (s *VulnerabilityService) createAndStartTrivyContainerInternal(return "", fmt.Errorf("failed to create container: %w", err)}+ if len(registryConfigJSON) > 0 {+ if err := copyRegistryConfigToContainerInternal(ctx, dockerClient, resp.ID, registryConfigJSON); err != nil {+ // DOCKER_CONFIG may still point at the target directory. When the+ // config file is absent, Trivy falls back to anonymous registry access.+ slog.WarnContext(ctx,+ "failed to inject registry credentials into trivy container; continuing anonymously",+ "scope", scope,+ "containerId", resp.ID,+ "error", err,+ )+ }+ }+startCtx, startCancel := timeouts.WithTimeout(ctx, 0, timeouts.DefaultDockerAPI)defer startCancel()@@ -3129,6 +3241,7 @@ func (s *VulnerabilityService) runTrivyContainer(imageID string,config *containertypes.Config,hostConfig *containertypes.HostConfig,+ registryConfigJSON []byte,) (*os.File, *os.File, int64, int64, string, error) {stdoutFile, err := createTrivyLogTempFileInternal("trivy-stdout-*")if err != nil {@@ -3150,7 +3263,7 @@ func (s *VulnerabilityService) runTrivyContainer(}}()- containerID, err = s.createAndStartTrivyContainerInternal(ctx, dockerClient, "single-scan", config, hostConfig)+ containerID, err = s.createAndStartTrivyContainerInternal(ctx, dockerClient, "single-scan", config, hostConfig, registryConfigJSON)if err != nil {return nil, nil, 0, 0, "", fmt.Errorf("failed to prepare trivy scan container: %w", err)}@@ -3334,7 +3447,13 @@ func (s *VulnerabilityService) runTrivyScan(ctx context.Context, trivyImage strireturn nil, err}- config := buildTrivyContainerConfig(trivyImage, cmdArgs, runtimeOptions.ContainerEnv)+ registryConfigJSON := s.buildTrivyRegistryConfigInternal(ctx)+ env := append([]string(nil), runtimeOptions.ContainerEnv...)+ if len(registryConfigJSON) > 0 {+ env = append(env, "DOCKER_CONFIG="+trivyRegistryConfigDir)+ }++ config := buildTrivyContainerConfig(trivyImage, cmdArgs, env)resources, cpuSet, applyLimits := s.getTrivyContainerResourceOptionsInternal(ctx, dockerClient)securityOpts, privileged := s.getTrivyRuntimeSecurityInternal()hostConfig := buildTrivyHostConfig(@@ -3349,7 +3468,7 @@ func (s *VulnerabilityService) runTrivyScan(ctx context.Context, trivyImage stri)s.setScanPhaseInternal(imageID, vulnerability.ScanPhaseCreatingContainer)- stdoutFile, stderrFile, duration, statusCode, containerID, err := s.runTrivyContainer(ctx, dockerClient, imageID, config, hostConfig)+ stdoutFile, stderrFile, duration, statusCode, containerID, err := s.runTrivyContainer(ctx, dockerClient, imageID, config, hostConfig, registryConfigJSON)if err != nil {return nil, err}diff --git a/backend/internal/services/vulnerability_service_test.go b/backend/internal/services/vulnerability_service_test.goindex 6f5e9c2d8..13148d68a 100644--- a/backend/internal/services/vulnerability_service_test.go+++ b/backend/internal/services/vulnerability_service_test.go@@ -2,6 +2,7 @@ package servicesimport ("context"+ "encoding/base64""encoding/json""errors""fmt"@@ -21,10 +22,81 @@ import (containertypes "github.com/moby/moby/api/types/container"mounttypes "github.com/moby/moby/api/types/mount"networktypes "github.com/moby/moby/api/types/network"+ dockerregistry "github.com/moby/moby/api/types/registry""github.com/stretchr/testify/require""gorm.io/gorm")+func TestBuildDockerConfigJSONInternal(t *testing.T) {+ tests := []struct {+ name string+ auths map[string]dockerregistry.AuthConfig+ wantAuths map[string]string+ }{+ {+ name: "nil map",+ },+ {+ name: "empty map",+ auths: map[string]dockerregistry.AuthConfig{},+ },+ {+ name: "one registry",+ auths: map[string]dockerregistry.AuthConfig{+ "registry.example.com": {Username: "user", Password: "pass"},+ },+ wantAuths: map[string]string{+ "registry.example.com": base64.StdEncoding.EncodeToString([]byte("user:pass")),+ },+ },+ {+ name: "skips blank credentials",+ auths: map[string]dockerregistry.AuthConfig{+ "registry.example.com": {Username: "user", Password: "pass"},+ "blank-user.example": {Username: "", Password: "pass"},+ "blank-pass.example": {Username: "user", Password: ""},+ " ": {Username: "user", Password: "pass"},+ },+ wantAuths: map[string]string{+ "registry.example.com": base64.StdEncoding.EncodeToString([]byte("user:pass")),+ },+ },+ {+ name: "two registries",+ auths: map[string]dockerregistry.AuthConfig{+ "registry-a.example.com": {Username: "user-a", Password: "pass-a"},+ "registry-b.example.com": {Username: "user-b", Password: "pass-b"},+ },+ wantAuths: map[string]string{+ "registry-a.example.com": base64.StdEncoding.EncodeToString([]byte("user-a:pass-a")),+ "registry-b.example.com": base64.StdEncoding.EncodeToString([]byte("user-b:pass-b")),+ },+ },+ }++ for _, tt := range tests {+ t.Run(tt.name, func(t *testing.T) {+ got, err := buildDockerConfigJSONInternal(tt.auths)+ require.NoError(t, err)+ if len(tt.wantAuths) == 0 {+ require.Nil(t, got)+ return+ }++ var parsed struct {+ Auths map[string]struct {+ Auth string `json:"auth"`+ } `json:"auths"`+ }+ require.NoError(t, json.Unmarshal(got, &parsed))+ require.Len(t, parsed.Auths, len(tt.wantAuths))+ for host, want := range tt.wantAuths {+ require.Equal(t, want, parsed.Auths[host].Auth)+ }+ })+ }+}+func TestIsExpectedDockerStreamEndErrorInternal(t *testing.T) {tests := []struct {name string