Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion internal/registry/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package registry
import (
"context"
"fmt"
"net/url"
"sort"
"strconv"
"strings"
Expand Down Expand Up @@ -389,12 +390,21 @@ func (r *Registry) registerScorecardMatcher() {
r.RegisterMatcherWithOptions(matcher, ComponentOptions{DefaultEnabled: false})
}
r.logger.Debug("scorecard matcher configured",
zap.String("api_base", scoreCfg.APIBase),
zap.String("api_base", endpointForLog(scoreCfg.APIBase)),
zap.String("cache_dir", scoreCfg.CacheDir),
zap.Duration("cache_ttl", scoreCfg.CacheTTL),
)
}

func endpointForLog(value string) string {
parsed, err := url.Parse(value)
if err != nil {
return "[invalid URL]"
}
parsed.User = nil
return parsed.String()
}

func (r *Registry) httpClientProvider() *sdk.HTTPClientProvider {
if r.httpProvider != nil {
return r.httpProvider
Expand Down
27 changes: 27 additions & 0 deletions internal/registry/builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@ package registry

import (
"slices"
"strings"
"testing"
"time"

"github.com/bomly-dev/bomly-cli/sdk"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zaptest/observer"
)

func TestBuildScanRegistryRegistersDetectorForEveryPackageManager(t *testing.T) {
Expand Down Expand Up @@ -155,3 +158,27 @@ func TestRegistryHTTPClientProviderReusesTransport(t *testing.T) {
t.Fatalf("timeouts = %v/%v, want 15s/30s", first.Timeout, second.Timeout)
}
}

func TestRegisterScorecardMatcherDoesNotLogEndpointCredentials(t *testing.T) {
core, logs := observer.New(zapcore.DebugLevel)
builtins := NewRegistry(Configs{
ScorecardAPIBase: "https://agent:super-secret@scorecard.example/api",
}, *zap.New(core))

builtins.registerScorecardMatcher()

entries := logs.FilterMessage("scorecard matcher configured").All()
if len(entries) != 1 {
t.Fatalf("scorecard configuration logs = %d, want 1", len(entries))
}
apiBase, ok := entries[0].ContextMap()["api_base"].(string)
if !ok {
t.Fatalf("api_base log field = %#v, want string", entries[0].ContextMap()["api_base"])
}
if apiBase != "https://scorecard.example/api" {
t.Fatalf("api_base log field = %q, want URL without credentials", apiBase)
}
if strings.Contains(apiBase, "agent") || strings.Contains(apiBase, "super-secret") {
t.Fatalf("api_base log field leaked credentials: %q", apiBase)
}
}