stackrox · parametalol · Nov 8, 2022 · Nov 3, 2022 · Nov 3, 2022 · Nov 4, 2022
diff --git a/central/main.go b/central/main.go
@@ -146,6 +146,7 @@ import (
 	"github.com/stackrox/rox/pkg/auth/authproviders/saml"
 	authProviderUserpki "github.com/stackrox/rox/pkg/auth/authproviders/userpki"
 	"github.com/stackrox/rox/pkg/auth/permissions"
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/pkg/concurrency"
 	"github.com/stackrox/rox/pkg/config"
 	"github.com/stackrox/rox/pkg/devbuild"
@@ -239,6 +240,8 @@ func main() {
 		return
 	}
 
+	clientconn.SetUserAgent("central")
+
 	ctx := context.Background()
 	proxy.WatchProxyConfig(ctx, proxyConfigPath, proxyConfigFile, true)
 

diff --git a/compliance/collection/main.go b/compliance/collection/main.go
@@ -184,6 +184,8 @@ func initializeStream(ctx context.Context, cli sensor.ComplianceServiceClient) (
 func main() {
 	log.Infof("Running StackRox Version: %s", version.GetMainVersion())
 
+	clientconn.SetUserAgent("compliance")
+
 	conn, err := clientconn.AuthenticatedGRPCConnection(env.AdvertisedEndpoint.Setting(), mtls.SensorSubject)
 	if err != nil {
 		log.Fatal(err)

diff --git a/pkg/clientconn/client.go b/pkg/clientconn/client.go
@@ -355,7 +355,7 @@ func AuthenticatedHTTPTransport(endpoint string, server mtls.Subject, baseTransp
 
 // GRPCConnection establishes a gRPC connection to the given server, using the given connection options.
 func GRPCConnection(dialCtx context.Context, server mtls.Subject, endpoint string, clientConnOpts Options, dialOpts ...grpc.DialOption) (*grpc.ClientConn, error) {
-	allDialOpts := make([]grpc.DialOption, 0, len(dialOpts)+2)
+	allDialOpts := make([]grpc.DialOption, 0, len(dialOpts)+3)
 
 	clientConnOpts.TLS.GRPCOnly = true
 
@@ -377,6 +377,7 @@ func GRPCConnection(dialCtx context.Context, server mtls.Subject, endpoint strin
 		allDialOpts = append(allDialOpts, grpc.WithPerRPCCredentials(perRPCCreds))
 	}
 	allDialOpts = append(allDialOpts, dialOpts...)
+	allDialOpts = append(allDialOpts, grpc.WithUserAgent(GetUserAgent()))
 	return clientConnOpts.dialTLSFunc()(dialCtx, endpoint, tlsConf, allDialOpts...)
 }
 

diff --git a/pkg/clientconn/useragent.go b/pkg/clientconn/useragent.go
@@ -0,0 +1,39 @@
+package clientconn
+
+import (
+	"fmt"
+	"os"
+	"runtime"
+	"strconv"
+
+	"github.com/stackrox/rox/pkg/version"
+)
+
+var userAgent string
+
+func init() {
+	SetUserAgent("stackrox")
+}
+
+// SetUserAgent formats and sets a value to be used in the User-Agent HTTP
+// header for the requests, initiated by a process.
+// Note: gorpc-go library will append the header value with its version,
+// e.g. grpc-go/1.50.1.
+func SetUserAgent(agent string) {
+	var ci string
+	if v, ok := os.LookupEnv("CI"); ok {
+		if v == "" {
+			ci = " CI"
+		} else if value, err := strconv.ParseBool(v); err == nil && value {
+			ci = " CI"
+		}
+	}
+	userAgent = fmt.Sprintf("%s/%s (%s; %s)%s", agent, version.GetMainVersion(), runtime.GOOS, runtime.GOARCH, ci)
+}
+
+// GetUserAgent returns the previously calculated value, which has to be set
+// by the process main function via a call to SetUserAgent().
+// Default value is the one produced by SetUserAgent("stackrox").
+func GetUserAgent() string {
+	return userAgent
+}
diff --git a/pkg/grpc/server.go b/pkg/grpc/server.go
@@ -18,6 +18,7 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/stackrox/rox/pkg/audit"
 	"github.com/stackrox/rox/pkg/auth/authproviders"
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/pkg/concurrency"
 	"github.com/stackrox/rox/pkg/contextutil"
 	"github.com/stackrox/rox/pkg/env"
@@ -228,7 +229,8 @@ func (a *apiImpl) connectToLocalEndpoint(dialCtxFunc pipeconn.DialContextFunc) (
 		grpc.WithContextDialer(func(ctx context.Context, endpoint string) (net.Conn, error) {
 			return dialCtxFunc(ctx)
 		}),
-		grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxResponseMsgSize())))
+		grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxResponseMsgSize())),
+		grpc.WithUserAgent(clientconn.GetUserAgent()))
 }
 
 func allowPrettyQueryParameter(h http.Handler) http.Handler {

@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/pkg/errox"
 	"github.com/stackrox/rox/pkg/utils"
 	"github.com/stackrox/rox/roxctl/common/flags"
@@ -138,7 +139,7 @@ func (client *roxctlClientImpl) NewReq(method string, path string, body io.Reade
 		return nil, errors.Wrap(err, "could not inject authentication information")
 	}
 
-	req.Header.Set("User-Agent", GetUserAgent())
+	req.Header.Set("User-Agent", clientconn.GetUserAgent())
 
 	return req, nil
 }
@@ -82,8 +82,6 @@ func GetGRPCConnection(logger logger.Logger) (*grpc.ClientConn, error) {
 		}
 	}
 
-	grpcDialOpts = append(grpcDialOpts, grpc.WithUserAgent(GetUserAgent()))
-
 	connection, err := clientconn.GRPCConnection(common.Context(), mtls.CentralSubject, endpoint, opts, grpcDialOpts...)
 	return connection, errors.WithStack(err)
 }
@@ -4,6 +4,7 @@ import (
 	"os"
 
 	"github.com/spf13/cobra"
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/roxctl/maincommand"
 	"github.com/stackrox/rox/roxctl/properties"
 
@@ -30,6 +31,8 @@ func main() {
 
 	PatchPersistentPreRunHooks(c)
 
+	clientconn.SetUserAgent("roxctl")
+
 	if err := c.Execute(); err != nil {
 		os.Exit(1)
 	}

@@ -66,6 +66,8 @@ func mainCmd() error {
 		log.Errorf("Failed to configure certificates: %v. Connection to sensor might fail.", err)
 	}
 
+	clientconn.SetUserAgent("admission-control")
+
 	// Note that the following call returns immediately (connecting happens in the background), hence this does not
 	// delay readiness of the admission-control service even if sensor is unavailable.
 	sensorConn, err := clientconn.AuthenticatedGRPCConnection(env.SensorEndpoint.Setting(), mtls.SensorSubject)

@@ -16,6 +16,7 @@ import (
 	"github.com/pkg/errors"
 	v1 "github.com/stackrox/rox/generated/api/v1"
 	"github.com/stackrox/rox/pkg/centralsensor"
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/pkg/cryptoutils"
 	"github.com/stackrox/rox/pkg/httputil"
 	"github.com/stackrox/rox/pkg/logging"
@@ -238,6 +239,8 @@ func (c *Client) doHTTPRequest(ctx context.Context, method, route string, params
 		return nil, nil, errors.Wrap(err, "creating tls-challenge request")
 	}
 
+	req.Header.Set("User-Agent", clientconn.GetUserAgent())
+
 	resp, err := c.httpClient.Do(req)
 	if err != nil {
 		return nil, nil, errors.Wrapf(err, "calling %s", u.String())

@@ -5,6 +5,7 @@ import (
 	"os/signal"
 
 	"github.com/pkg/errors"
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/pkg/devmode"
 	"github.com/stackrox/rox/pkg/env"
 	"github.com/stackrox/rox/pkg/logging"
@@ -46,6 +47,7 @@ func main() {
 	} else {
 		sharedClientInterface = client.MustCreateInterface()
 	}
+	clientconn.SetUserAgent("sensor")
 	centralConnFactory, err := centralclient.NewCentralConnectionFactory(env.CentralEndpoint.Setting())
 	if err != nil {
 		utils.CrashOnError(errors.Wrapf(err, "sensor failed to start while initializing gRPC client to endpoint %s", env.CentralEndpoint.Setting()))

@@ -4,6 +4,7 @@ import (
 	"context"
 	"flag"
 
+	"github.com/stackrox/rox/pkg/clientconn"
 	"github.com/stackrox/rox/pkg/logging"
 	"github.com/stackrox/rox/pkg/utils"
 	"github.com/stackrox/rox/pkg/version"
@@ -34,6 +35,8 @@ func mainCmd() error {
 		return err
 	}
 
+	clientconn.SetUserAgent("upgrader")
+
 	upgradeCtx, err := upgradectx.Create(context.Background(), upgraderCfg)
 	if err != nil {
 		return err

@@ -266,6 +266,8 @@ func (c *UpgradeContext) DoCentralHTTPRequest(req *http.Request) (*http.Response
 		return nil, errors.New("no HTTP client configured")
 	}
 
+	req.Header.Set("User-Agent", clientconn.GetUserAgent())
+
 	return c.centralHTTPClient.Do(req)
 }
-Original file line number
+Diff line change
@@ Expand Up @@
     		return nil, errors.New("no HTTP client configured")
     	}
+    	req.Header.Set("User-Agent", clientconn.GetUserAgent())
     	return c.centralHTTPClient.Do(req)
     }
@@ Expand Down @@