feat: add user-agent to client requests

Signed-off-by: Antonio Murdaca <[email protected]>

Author: runcom

.packit.yaml

@@ -37,8 +37,6 @@ actions:
     - make vendor-tarball VERSION=${PACKIT_PROJECT_VERSION}
   create-archive:
     - make packit-create-archive VERSION=${PACKIT_PROJECT_VERSION}
-  fix-spec-file:
-    - bash -c "sed -i -r \"s/Version:(\s*)\S+/Version:\1${PACKIT_PROJECT_VERSION}%{?dist}/\" build/package/rpm/go-fdo-client.spec"
 
 jobs:
   - &copr_fedora

Makefile

@@ -1,13 +1,13 @@
 COMMIT  := $(shell git rev-parse --short HEAD)
 DATE    := $(shell date "+%Y%m%d")
+VERSION := git$(DATE).$(COMMIT)
 PROJECT := go-fdo-client
 
 SOURCEDIR               := $(CURDIR)/build/package/rpm
 SPEC_FILE_NAME          := $(PROJECT).spec
 SPEC_FILE               := $(SOURCEDIR)/$(SPEC_FILE_NAME)
 GO_VENDOR_TOOLS_FILE    := $(SOURCEDIR)/go-vendor-tools.toml
 GO_VENDOR_TOOLS_FILE_NAME := go-vendor-tools.toml
-VERSION ?= $(shell git describe --always --dirty --tags 2>/dev/null || echo "undefined")
 
 SOURCE_TARBALL := $(SOURCEDIR)/$(PROJECT)-$(VERSION).tar.gz
 VENDOR_TARBALL := $(SOURCEDIR)/$(PROJECT)-$(VERSION)-vendor.tar.gz
@@ -17,7 +17,7 @@ VENDOR_TARBALL := $(SOURCEDIR)/$(PROJECT)-$(VERSION)-vendor.tar.gz
 all: build test
 
 build: tidy fmt vet
-	go build -ldflags="-X github.com/fido-device-onboard/go-fdo-client/internal/version/version.VERSION=${VERSION}"
+	go build -ldflags="-X github.com/fido-device-onboard/go-fdo-client/internal/version.VERSION=${VERSION}"
 
 tidy:
 	go mod tidy
@@ -32,7 +32,7 @@ test:
 	go test -v ./...
 
 # Packit helpers
-.PHONY: vendor-tarball packit-create-archive vendor-licenses render-specfile
+.PHONY: vendor-tarball packit-create-archive vendor-licenses
 
 vendor-tarball: $(VENDOR_TARBALL)
 
@@ -81,7 +81,6 @@ RPMBUILD_SPECFILE                 := $(RPMBUILD_SPECS_DIR)/$(PROJECT)-$(VERSION)
 RPMBUILD_TARBALL                  := $(RPMBUILD_SOURCES_DIR)/$(PROJECT)-$(VERSION).tar.gz
 RPMBUILD_VENDOR_TARBALL           := $(RPMBUILD_SOURCES_DIR)/$(PROJECT)-$(VERSION)-vendor.tar.gz
 
-render-specfile: $(RPMBUILD_SPECFILE)
 # Render a versioned spec into ./rpmbuild/specs (keeps source spec pristine)
 $(RPMBUILD_SPECFILE):
 	mkdir -p $(RPMBUILD_SPECS_DIR)

build/package/rpm/go-fdo-client.spec

@@ -39,7 +39,7 @@ BuildRequires: golang
 
 %build
 %global gomodulesmode GO111MODULE=on
-export LDFLAGS="-X %{goipath}/internal/version/version.VERSION=%{version}"
+export LDFLAGS="-X %{goipath}/internal/version.VERSION=%{version}"
 %gobuild -o %{gobuilddir}/bin/go-fdo-client %{goipath}
 
 %install

internal/tls/tls.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/fido-device-onboard/go-fdo"
+	"github.com/fido-device-onboard/go-fdo-client/internal/version"
 	"github.com/fido-device-onboard/go-fdo/http"
 )
 
@@ -29,7 +30,7 @@ func TlsTransport(baseURL string, conf *tls.Config, insecureTLS bool) fdo.Transp
 
 	return &http.Transport{
 		BaseURL: baseURL,
-		Client: &net_http.Client{Transport: &net_http.Transport{
+		Client: &net_http.Client{Transport: &userAgentTransport{&net_http.Transport{
 			Proxy: net_http.ProxyFromEnvironment,
 			DialContext: (&net.Dialer{
 				Timeout:   30 * time.Second,
@@ -41,6 +42,22 @@ func TlsTransport(baseURL string, conf *tls.Config, insecureTLS bool) fdo.Transp
 			TLSClientConfig:       conf,
 			TLSHandshakeTimeout:   10 * time.Second,
 			ExpectContinueTimeout: 1 * time.Second,
-		}},
+		}, "go-fdo-client/" + version.VERSION}},
 	}
 }
+
+type userAgentTransport struct {
+	next      net_http.RoundTripper
+	userAgent string
+}
+
+func (t *userAgentTransport) RoundTrip(req *net_http.Request) (*net_http.Response, error) {
+	r := req.Clone(req.Context())
+	if r.Header == nil {
+		r.Header = make(net_http.Header)
+	}
+	if r.Header.Get("User-Agent") == "" {
+		r.Header.Set("User-Agent", t.userAgent)
+	}
+	return t.next.RoundTrip(r)
+}

internal/version/version.go

@@ -1,3 +1,4 @@
 package version
 
+// VERSION is the build version, set at build time using -ldflags.
 var VERSION = "unknown"