fix: expose version and user agent to consumers (#158)

internal/test/test.go

@@ -16,9 +16,9 @@ import (
 	"time"
 
 	"github.com/docker/attest/attestation"
-	"github.com/docker/attest/internal/useragent"
 	"github.com/docker/attest/signerverifier"
 	"github.com/docker/attest/tlog"
+	"github.com/docker/attest/useragent"
 	"github.com/google/go-containerregistry/pkg/registry"
 	"github.com/secure-systems-lab/go-securesystemslib/dsse"
 )

internal/useragent/useragent.go

@@ -1,31 +0,0 @@
-package useragent
-
-import (
-	"context"
-
-	"github.com/docker/attest/internal/version"
-)
-
-type userAgentKeyType string
-
-const (
-	userAgentKey     userAgentKeyType = "attest-user-agent"
-	defaultUserAgent string           = "attest/unknown (docker)"
-)
-
-func Set(ctx context.Context, userAgent string) context.Context {
-	return context.WithValue(ctx, userAgentKey, userAgent)
-}
-
-// Get retrieves the HTTP user agent from the context.
-func Get(ctx context.Context) string {
-	if ua, ok := ctx.Value(userAgentKey).(string); ok {
-		return ua
-	}
-	version, err := version.Get()
-	if err != nil || version == nil {
-		return defaultUserAgent
-	}
-
-	return "attest/" + version.String() + " (docker)"
-}

internal/useragent/useragent_test.go

@@ -1,19 +0,0 @@
-package useragent
-
-import (
-	"context"
-	"testing"
-)
-
-// test the user agent setting and getting.
-func TestSetUserAgent(t *testing.T) {
-	ctx := context.Background()
-	if Get(ctx) != defaultUserAgent {
-		t.Errorf("expected user agent to be '%s', got %q", defaultUserAgent, Get(ctx))
-	}
-
-	ctx = Set(ctx, "test-agent")
-	if Get(ctx) != "test-agent" {
-		t.Errorf("expected user agent to be 'test-agent', got %q", Get(ctx))
-	}
-}

internal/version/version.go

@@ -1,39 +0,0 @@
-package version
-
-import (
-	"fmt"
-	"runtime/debug"
-
-	"github.com/Masterminds/semver/v3"
-)
-
-const ThisModulePath = "github.com/docker/attest"
-
-// Get returns the version of the attest module.
-// this can return nil if the version can't be determined (without an error).
-func Get() (*semver.Version, error) {
-	var attestMod *debug.Module
-	bi, ok := debug.ReadBuildInfo()
-	if !ok {
-		return nil, nil
-	}
-	if bi.Main.Path == ThisModulePath {
-		attestMod = &bi.Main
-	} else {
-		for _, dep := range bi.Deps {
-			if dep.Path == ThisModulePath {
-				attestMod = dep
-				break
-			}
-		}
-	}
-	if attestMod == nil {
-		return nil, nil
-	}
-
-	attestVersion, err := semver.NewVersion(attestMod.Version)
-	if err != nil {
-		return nil, fmt.Errorf("failed to parse version %s: %w", attestMod.Version, err)
-	}
-	return attestVersion, nil
-}