Merge pull request #152 from lacework/afiune/146/user-agent-header

feat: set User-Agent header (backend metrics)

Author: afiune

api/client.go

@@ -41,6 +41,7 @@ type Client struct {
 	auth       *authConfig
 	c          *http.Client
 	log        *zap.Logger
+	headers    map[string]string
 
 	Events          *EventsService
 	Compliance      *ComplianceService
@@ -81,6 +82,9 @@ func NewClient(account string, opts ...Option) (*Client, error) {
 		account:    account,
 		baseURL:    baseURL,
 		apiVersion: "v1",
+		headers: map[string]string{
+			"User-Agent": fmt.Sprintf("Go Client/%s", Version),
+		},
 		auth: &authConfig{
 			expiration: defaultTokenExpiryTime,
 		},
@@ -123,6 +127,17 @@ func WithURL(baseURL string) Option {
 	})
 }
 
+// WithHeader configures a HTTP Header to pass to every request
+func WithHeader(header, value string) Option {
+	return clientFunc(func(c *Client) error {
+		if header != "" && value != "" {
+			c.log.Debug("setting up header", zap.String(header, value))
+			c.headers[header] = value
+		}
+		return nil
+	})
+}
+
 // URL returns the base url configured
 func (c *Client) URL() string {
 	return c.baseURL.String()

api/client_test.go

@@ -54,6 +54,7 @@ func TestNewClientWithOptions(t *testing.T) {
 		api.WithExpirationTime(1800),
 		api.WithApiV2(),
 		api.WithLogLevel("DEBUG"),
+		api.WithHeader("User-Agent", "test-agent"),
 		api.WithTokenFromKeys("KEY", "SECRET"), // this option has to be the last one
 	)
 	if assert.Nil(t, err) {

api/http.go

@@ -71,6 +71,12 @@ func (c *Client) NewRequest(method string, apiURL string, body io.Reader) (*http
 		request.Header.Set(k, v)
 	}
 
+	// add all global headers that the client has configured,
+	// by default we set only the User-Agent header
+	for k, v := range c.headers {
+		request.Header.Set(k, v)
+	}
+
 	// parse and encode query string values
 	values := request.URL.Query()
 	request.URL.RawQuery = values.Encode()
@@ -79,7 +85,7 @@ func (c *Client) NewRequest(method string, apiURL string, body io.Reader) (*http
 		zap.String("method", request.Method),
 		zap.String("url", c.baseURL.String()),
 		zap.String("endpoint", apiPath.String()),
-		zap.Reflect("headers", c.httpHeadersSniffer(headers)),
+		zap.Reflect("headers", c.httpHeadersSniffer(request.Header)),
 		zap.String("body", c.httpRequestBodySniffer(request)),
 	)
 

api/version.go

@@ -0,0 +1,35 @@
+//
+// Author:: Salim Afiune Maya (<afiune@lacework.net>)
+// Copyright:: Copyright 2020, Lacework Inc.
+// License:: Apache License, Version 2.0
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+package api_test
+
+import (
+	"io/ioutil"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	subject "github.com/lacework/go-sdk/api"
+)
+
+func TestVersionMatchVERSIONfile(t *testing.T) {
+	expectedVersion, err := ioutil.ReadFile("../VERSION")
+	assert.Nil(t, err)
+	assert.Equalf(t, string(expectedVersion), subject.Version,
+		"api/version.go doesn't match with VERSION file; run scripts/version_updater.sh")
+}

api/version_test.go

@@ -25,7 +25,6 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
-	"github.com/lacework/go-sdk/api"
 	"github.com/lacework/go-sdk/internal/array"
 )
 
@@ -77,16 +76,8 @@ func runApiCommand(_ *cobra.Command, args []string) error {
 		}
 	}
 
-	lacework, err := api.NewClient(cli.Account,
-		api.WithLogLevel(cli.LogLevel),
-		api.WithApiKeys(cli.KeyID, cli.Secret),
-	)
-	if err != nil {
-		return errors.Wrap(err, "unable to generate api client")
-	}
-
 	response := new(map[string]interface{})
-	err = lacework.RequestDecoder(
+	err := cli.LwApi.RequestDecoder(
 		strings.ToUpper(args[0]),
 		strings.TrimPrefix(args[1], "/"),
 		strings.NewReader(apiData),

cli/cmd/api.go

@@ -28,6 +28,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
+
+	"github.com/lacework/go-sdk/api"
 )
 
 // cliState holds the state of the entire Lacework CLI
@@ -39,6 +41,7 @@ type cliState struct {
 	Token    string
 	LogLevel string
 
+	LwApi *api.Client
 	JsonF *prettyjson.Formatter
 	Log   *zap.SugaredLogger
 
@@ -128,6 +131,26 @@ func (c *cliState) VerifySettings() error {
 	return nil
 }
 
+// NewClient creates and stores a new Lacework API client to be used by the CLI
+func (c *cliState) NewClient() error {
+	err := c.VerifySettings()
+	if err != nil {
+		return err
+	}
+
+	client, err := api.NewClient(c.Account,
+		api.WithLogLevel(c.LogLevel),
+		api.WithApiKeys(c.KeyID, c.Secret),
+		api.WithHeader("User-Agent", fmt.Sprintf("Command-Line/%s", Version)),
+	)
+	if err != nil {
+		return errors.Wrap(err, "unable to generate api client")
+	}
+
+	c.LwApi = client
+	return nil
+}
+
 // InteractiveMode returns true if the cli is running in interactive mode
 func (c *cliState) InteractiveMode() bool {
 	return !c.nonInteractive

cli/cmd/cli_state.go

@@ -23,9 +23,10 @@ import (
 	"sort"
 	"strings"
 
-	"github.com/lacework/go-sdk/api"
 	"github.com/olekukonko/tablewriter"
 	"github.com/spf13/cobra"
+
+	"github.com/lacework/go-sdk/api"
 )
 
 var (

cli/cmd/compliance.go

@@ -23,10 +23,11 @@ import (
 	"strings"
 	"time"
 
-	"github.com/lacework/go-sdk/api"
 	"github.com/olekukonko/tablewriter"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
+
+	"github.com/lacework/go-sdk/api"
 )
 
 var (
@@ -63,22 +64,14 @@ To run an ad-hoc compliance assessment use the command:
 `,
 		Args: cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, args []string) error {
-			lacework, err := api.NewClient(cli.Account,
-				api.WithLogLevel(cli.LogLevel),
-				api.WithApiKeys(cli.KeyID, cli.Secret),
-			)
-			if err != nil {
-				return errors.Wrap(err, "unable to generate api client")
-			}
-
 			config := api.ComplianceAwsReportConfig{
 				AccountID: args[0],
 				Type:      compCmdState.Type,
 			}
 
 			if compCmdState.PdfName != "" {
 				cli.StartProgress(" Downloading compliance report...")
-				err := lacework.Compliance.DownloadAwsReportPDF(compCmdState.PdfName, config)
+				err := cli.LwApi.Compliance.DownloadAwsReportPDF(compCmdState.PdfName, config)
 				cli.StopProgress()
 				if err != nil {
 					return errors.Wrap(err, "unable to get aws pdf compliance report")
@@ -89,7 +82,7 @@ To run an ad-hoc compliance assessment use the command:
 			}
 
 			cli.StartProgress(" Getting compliance report...")
-			response, err := lacework.Compliance.GetAwsReport(config)
+			response, err := cli.LwApi.Compliance.GetAwsReport(config)
 			cli.StopProgress()
 			if err != nil {
 				return errors.Wrap(err, "unable to get aws compliance report")
@@ -124,15 +117,7 @@ To run an ad-hoc compliance assessment use the command:
 		Long:    `Run a compliance assessment for the provided AWS account.`,
 		Args:    cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, args []string) error {
-			lacework, err := api.NewClient(cli.Account,
-				api.WithLogLevel(cli.LogLevel),
-				api.WithApiKeys(cli.KeyID, cli.Secret),
-			)
-			if err != nil {
-				return errors.Wrap(err, "unable to generate api client")
-			}
-
-			response, err := lacework.Compliance.RunAwsReport(args[0])
+			response, err := cli.LwApi.Compliance.RunAwsReport(args[0])
 			if err != nil {
 				return errors.Wrap(err, "unable to run aws compliance report")
 			}

cli/cmd/compliance_aws.go

@@ -23,10 +23,11 @@ import (
 	"strings"
 	"time"
 
-	"github.com/lacework/go-sdk/api"
 	"github.com/olekukonko/tablewriter"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
+
+	"github.com/lacework/go-sdk/api"
 )
 
 var (
@@ -47,15 +48,7 @@ Then, select one GUID from an integration and visialize its details using the co
 `,
 		Args: cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, args []string) error {
-			lacework, err := api.NewClient(cli.Account,
-				api.WithLogLevel(cli.LogLevel),
-				api.WithApiKeys(cli.KeyID, cli.Secret),
-			)
-			if err != nil {
-				return errors.Wrap(err, "unable to generate api client")
-			}
-
-			response, err := lacework.Compliance.ListAzureSubscriptions(args[0])
+			response, err := cli.LwApi.Compliance.ListAzureSubscriptions(args[0])
 			if err != nil {
 				return errors.Wrap(err, "unable to list azure subscriptions")
 			}
@@ -94,14 +87,6 @@ To run an ad-hoc compliance assessment use the command:
 `,
 		Args: cobra.ExactArgs(2),
 		RunE: func(_ *cobra.Command, args []string) error {
-			lacework, err := api.NewClient(cli.Account,
-				api.WithLogLevel(cli.LogLevel),
-				api.WithApiKeys(cli.KeyID, cli.Secret),
-			)
-			if err != nil {
-				return errors.Wrap(err, "unable to generate api client")
-			}
-
 			config := api.ComplianceAzureReportConfig{
 				TenantID:       args[0],
 				SubscriptionID: args[1],
@@ -110,7 +95,7 @@ To run an ad-hoc compliance assessment use the command:
 
 			if compCmdState.PdfName != "" {
 				cli.StartProgress(" Downloading compliance report...")
-				err := lacework.Compliance.DownloadAzureReportPDF(compCmdState.PdfName, config)
+				err := cli.LwApi.Compliance.DownloadAzureReportPDF(compCmdState.PdfName, config)
 				cli.StopProgress()
 				if err != nil {
 					return errors.Wrap(err, "unable to get azure pdf compliance report")
@@ -121,7 +106,7 @@ To run an ad-hoc compliance assessment use the command:
 			}
 
 			cli.StartProgress(" Getting compliance report...")
-			response, err := lacework.Compliance.GetAzureReport(config)
+			response, err := cli.LwApi.Compliance.GetAzureReport(config)
 			cli.StopProgress()
 			if err != nil {
 				return errors.Wrap(err, "unable to get azure compliance report")
@@ -156,15 +141,7 @@ To run an ad-hoc compliance assessment use the command:
 		Long:    `Run a compliance assessment of the provided Azure tenant.`,
 		Args:    cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, args []string) error {
-			lacework, err := api.NewClient(cli.Account,
-				api.WithLogLevel(cli.LogLevel),
-				api.WithApiKeys(cli.KeyID, cli.Secret),
-			)
-			if err != nil {
-				return errors.Wrap(err, "unable to generate api client")
-			}
-
-			response, err := lacework.Compliance.RunAzureReport(args[0])
+			response, err := cli.LwApi.Compliance.RunAzureReport(args[0])
 			if err != nil {
 				return errors.Wrap(err, "unable to run azure compliance assessment")
 			}