Merge pull request #278 from BaruchBilanski/SLK-86768-User-Agent

SLK-86768 | Add user agent for login

Author: semyonm0r

.goreleaser.yml

@@ -15,7 +15,7 @@ builds:
   flags:
     - -trimpath
   ldflags:
-    - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
+    - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X github.com/aquasecurity/terraform-provider-aquasec/client.version={{.Version}}'
   goos:
     - freebsd
     - windows

GNUmakefile

@@ -14,7 +14,7 @@ default: build
 build:
 	go get
 	go mod vendor
-	go build -ldflags "-X main.version=v${VERSION}" -o ${BINARY}
+	go build -ldflags "-X main.version=v${VERSION} -X github.com/aquasecurity/terraform-provider-aquasec/client.version=v${VERSION}" -o ${BINARY}
 
 install: build
 	mkdir -p ~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/${VERSION}/${OS_ARCH}

client/client.go

@@ -5,12 +5,13 @@ import (
 	"crypto/x509"
 	"encoding/json"
 	"fmt"
+	"log"
+	neturl "net/url"
+
 	"github.com/aquasecurity/terraform-provider-aquasec/consts"
 	"github.com/parnurzeal/gorequest"
 	"golang.org/x/net/http/httpproxy"
 	"golang.org/x/time/rate"
-	"log"
-	neturl "net/url"
 )
 
 // Client - API client
@@ -30,6 +31,10 @@ const Csp string = "csp"
 const Saas = "saas"
 const SaasDev = "saasDev"
 
+const UserAgentBase = "terraform-provider-aquasec"
+
+var version string
+
 // NewClient - initialize and return the Client
 func NewClient(url, user, password string, verifyTLS bool, caCertByte []byte) *Client {
 	tlsConfig := &tls.Config{
@@ -47,11 +52,13 @@ func NewClient(url, user, password string, verifyTLS bool, caCertByte []byte) *C
 		}
 	}
 
+	request := gorequest.New().TLSClientConfig(tlsConfig)
+
 	c := &Client{
 		url:       url,
 		user:      user,
 		password:  password,
-		gorequest: gorequest.New().TLSClientConfig(tlsConfig),
+		gorequest: request,
 		// we are setting rate limit for 10 connection per second
 		limiter: rate.NewLimiter(10, 3),
 	}
@@ -121,7 +128,7 @@ func (cli *Client) GetAuthToken() (string, string, error) {
 
 // GetAuthToken - Connect to Aqua and return a JWT bearerToken (string)
 func (cli *Client) GetCspAuthToken() (string, error) {
-	resp, body, errs := cli.gorequest.Post(cli.url + "/api/v1/login").
+	resp, body, errs := cli.makeRequest().Post(cli.url + "/api/v1/login").
 		Send(`{"id":"` + cli.user + `", "password":"` + cli.password + `"}`).End()
 	if errs != nil {
 		return "", getMergedError(errs)
@@ -164,7 +171,7 @@ func (cli *Client) GetUSEAuthToken() (string, string, error) {
 		return "", "", fmt.Errorf(fmt.Sprintf("%v URL is not allowed USE url", cli.url))
 	}
 
-	resp, body, errs := cli.gorequest.Post(cli.tokenUrl + "/v2/signin").
+	resp, body, errs := cli.makeRequest().Post(cli.tokenUrl + "/v2/signin").
 		Send(`{"email":"` + cli.user + `", "password":"` + cli.password + `"}`).End()
 	if errs != nil {
 		return "", "", getMergedError(errs)
@@ -198,3 +205,8 @@ func (cli *Client) GetUSEAuthToken() (string, string, error) {
 
 	return "", "", fmt.Errorf("request failed. status: %s, response: %s", resp.Status, body)
 }
+
+func (cli *Client) makeRequest() *gorequest.SuperAgent {
+	userAgent := fmt.Sprintf("%s/%s", UserAgentBase, version)
+	return cli.gorequest.Clone().Set("User-Agent", userAgent)
+}