Merge remote-tracking branch 'upstream/dev'

Author: EyalDelarea

README.md

@@ -1918,6 +1918,11 @@ serviceConfig, err := config.NewConfigBuilder().
 xrayManager, err := xray.New(serviceConfig)
 ```
 
+If the provided token is scoped for a `project` you need to set its value in the manager for authentications in relevant API's
+```go
+xrayManager, err := xray.New(serviceConfig).SetProjectKey("project")
+```
+
 ### Using Xray Services
 
 #### Fetching Xray's Version

go.mod

@@ -10,7 +10,7 @@ require (
 	github.com/golang-jwt/jwt/v4 v4.5.2
 	github.com/gookit/color v1.5.4
 	github.com/jfrog/archiver/v3 v3.6.1
-	github.com/jfrog/build-info-go v1.10.11
+	github.com/jfrog/build-info-go v1.10.12
 	github.com/jfrog/gofrog v1.7.6
 	github.com/minio/sha256-simd v1.0.1
 	github.com/stretchr/testify v1.10.0

go.sum

@@ -57,8 +57,8 @@ github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOl
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jfrog/archiver/v3 v3.6.1 h1:LOxnkw9pOn45DzCbZNFV6K0+6dCsQ0L8mR3ZcujO5eI=
 github.com/jfrog/archiver/v3 v3.6.1/go.mod h1:VgR+3WZS4N+i9FaDwLZbq+jeU4B4zctXL+gL4EMzfLw=
-github.com/jfrog/build-info-go v1.10.11 h1:wAMGCAHa49+ec01HqzSidLAHNIub+glh4ksFp3pYy7o=
-github.com/jfrog/build-info-go v1.10.11/go.mod h1:JcISnovFXKx3wWf3p1fcMmlPdt6adxScXvoJN4WXqIE=
+github.com/jfrog/build-info-go v1.10.12 h1:KO/YUeKYtDrnpcmsXmwqr6akjzrwA0hSTUB+Op/HF88=
+github.com/jfrog/build-info-go v1.10.12/go.mod h1:JcISnovFXKx3wWf3p1fcMmlPdt6adxScXvoJN4WXqIE=
 github.com/jfrog/gofrog v1.7.6 h1:QmfAiRzVyaI7JYGsB7cxfAJePAZTzFz0gRWZSE27c6s=
 github.com/jfrog/gofrog v1.7.6/go.mod h1:ntr1txqNOZtHplmaNd7rS4f8jpA5Apx8em70oYEe7+4=
 github.com/kevinburke/ssh_config v1.2.0 h1:x584FjTGwHzMwvHx18PXxbBVzfnxogHaAReU4gf13a4=

utils/utils.go

@@ -28,7 +28,7 @@ import (
 const (
 	Development = "development"
 	Agent       = "jfrog-client-go"
-	Version     = "1.53.0"
+	Version     = "1.53.1"
 )
 
 const xrayDevVersion = "3.x-dev"
@@ -622,3 +622,29 @@ func SetEnvWithResetCallback(key, value string) (func() error, error) {
 		return errorutils.CheckError(os.Unsetenv(key))
 	}, nil
 }
+
+const (
+	// If the access token used for the client is project-scoped, the API call needs to contain the project key as query param to pass to the Server.
+	ProjectKeyQueryParam = "projectKey="
+)
+
+// To access some of the API calls in Xray, we need to add the project key as a query parameter (used for validations if the token is project-scoped).
+func AppendScopedProjectKeyParam(url, projectKey string) string {
+	// make sure the project key is not empty and not already in the URL
+	if projectKey == "" || urlContainsProjectKeyParam(url) {
+		return url
+	}
+	if strings.Contains(url, "?") {
+		// the URL already contains query parameters, append the project key with an '&'
+		url += "&" + ProjectKeyQueryParam + projectKey
+	} else {
+		// the URL does not contain any query parameters, add the project key with a '?'
+		url += "?" + ProjectKeyQueryParam + projectKey
+	}
+	return url
+}
+
+func urlContainsProjectKeyParam(url string) bool {
+	// check if the URL already contains the project key query parameter
+	return len(url) > 0 && strings.Contains(url, ProjectKeyQueryParam)
+}

xray/manager.go

@@ -12,6 +12,8 @@ import (
 type XrayServicesManager struct {
 	client *jfroghttpclient.JfrogHttpClient
 	config config.Config
+	// Global reference to the provided project key, used for API endpoints that require it for authentication
+	scopeProjectKey string
 }
 
 // New creates a service manager to interact with Xray
@@ -34,6 +36,11 @@ func New(config config.Config) (*XrayServicesManager, error) {
 	return manager, err
 }
 
+func (sm *XrayServicesManager) SetProjectKey(projectKey string) *XrayServicesManager {
+	sm.scopeProjectKey = projectKey
+	return sm
+}
+
 // Client will return the http client
 func (sm *XrayServicesManager) Client() *jfroghttpclient.JfrogHttpClient {
 	return sm.client
@@ -154,6 +161,7 @@ func (sm *XrayServicesManager) IsTokenValidationEnabled() (isEnabled bool, err e
 func (sm *XrayServicesManager) ScanGraph(params services.XrayGraphScanParams) (scanId string, err error) {
 	scanService := services.NewScanService(sm.client)
 	scanService.XrayDetails = sm.config.GetServiceDetails()
+	scanService.ScopeProjectKey = sm.scopeProjectKey
 	return scanService.ScanGraph(params)
 }
 
@@ -162,6 +170,7 @@ func (sm *XrayServicesManager) ScanGraph(params services.XrayGraphScanParams) (s
 func (sm *XrayServicesManager) GetScanGraphResults(scanID, xrayVersion string, includeVulnerabilities, includeLicenses, xscEnabled bool) (*services.ScanResponse, error) {
 	scanService := services.NewScanService(sm.client)
 	scanService.XrayDetails = sm.config.GetServiceDetails()
+	scanService.ScopeProjectKey = sm.scopeProjectKey
 	return scanService.GetScanGraphResults(scanID, xrayVersion, includeVulnerabilities, includeLicenses, xscEnabled)
 }
 
@@ -185,6 +194,7 @@ func (sm *XrayServicesManager) GetImportGraphResults(scanID string) (*services.S
 func (sm *XrayServicesManager) BuildScan(params services.XrayBuildParams, includeVulnerabilities bool) (scanResponse *services.BuildScanResponse, noFailBuildPolicy bool, err error) {
 	buildScanService := services.NewBuildScanService(sm.client)
 	buildScanService.XrayDetails = sm.config.GetServiceDetails()
+	buildScanService.ScopeProjectKey = sm.scopeProjectKey
 	return buildScanService.ScanBuild(params, includeVulnerabilities)
 }
 
@@ -241,12 +251,14 @@ func (sm *XrayServicesManager) ArtifactSummary(params services.ArtifactSummaryPa
 func (sm *XrayServicesManager) IsEntitled(featureId string) (bool, error) {
 	entitlementsService := services.NewEntitlementsService(sm.client)
 	entitlementsService.XrayDetails = sm.config.GetServiceDetails()
+	entitlementsService.ScopeProjectKey = sm.scopeProjectKey
 	return entitlementsService.IsEntitled(featureId)
 }
 
 // Xsc returns the Xsc service inside Xray
 func (sm *XrayServicesManager) Xsc() *xsc.XscInnerService {
 	xscService := xsc.NewXscService(sm.client)
 	xscService.XrayDetails = sm.config.GetServiceDetails()
+	xscService.ScopeProjectKey = sm.scopeProjectKey
 	return xscService
 }

xray/services/buildscan.go

@@ -4,14 +4,16 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"net/http"
+	"strings"
+
 	"github.com/jfrog/gofrog/version"
 	"github.com/jfrog/jfrog-client-go/auth"
 	"github.com/jfrog/jfrog-client-go/http/jfroghttpclient"
+	"github.com/jfrog/jfrog-client-go/utils"
 	"github.com/jfrog/jfrog-client-go/utils/errorutils"
 	"github.com/jfrog/jfrog-client-go/utils/io/httputils"
 	"github.com/jfrog/jfrog-client-go/utils/log"
-	"net/http"
-	"strings"
 )
 
 const (
@@ -25,8 +27,9 @@ const (
 )
 
 type BuildScanService struct {
-	client      *jfroghttpclient.JfrogHttpClient
-	XrayDetails auth.ServiceDetails
+	client          *jfroghttpclient.JfrogHttpClient
+	XrayDetails     auth.ServiceDetails
+	ScopeProjectKey string
 }
 
 // NewBuildScanService creates a new service to scan build dependencies.
@@ -61,7 +64,7 @@ func (bs *BuildScanService) triggerScan(paramsBytes []byte) error {
 	httpClientsDetails.SetContentTypeApplicationJson()
 	url := bs.XrayDetails.GetUrl() + BuildScanAPI
 
-	resp, body, err := bs.client.SendPost(url, paramsBytes, &httpClientsDetails)
+	resp, body, err := bs.client.SendPost(utils.AppendScopedProjectKeyParam(url, bs.ScopeProjectKey), paramsBytes, &httpClientsDetails)
 	if err != nil {
 		return err
 	}
@@ -149,7 +152,7 @@ func (bs *BuildScanService) getResultsGetRequestFunc(params XrayBuildParams, htt
 		endPoint += "?" + strings.Join(queryParams, "&")
 	}
 	return func() (*http.Response, []byte, error) {
-		resp, body, _, err := bs.client.SendGet(endPoint, true, httpClientsDetails)
+		resp, body, _, err := bs.client.SendGet(utils.AppendScopedProjectKeyParam(endPoint, bs.ScopeProjectKey), true, httpClientsDetails)
 		return resp, body, err
 	}
 }
@@ -163,7 +166,7 @@ func (bs *BuildScanService) getResultsPostRequestFunc(params XrayBuildParams, pa
 		endPoint += "?" + strings.Join(queryParams, "&")
 	}
 	return func() (*http.Response, []byte, error) {
-		resp, body, err := bs.client.SendPost(endPoint, paramsBytes, httpClientsDetails)
+		resp, body, err := bs.client.SendPost(utils.AppendScopedProjectKeyParam(endPoint, bs.ScopeProjectKey), paramsBytes, httpClientsDetails)
 		return resp, body, err
 	}
 }

xray/services/entitlements.go

@@ -8,12 +8,14 @@ import (
 
 	"github.com/jfrog/jfrog-client-go/auth"
 	"github.com/jfrog/jfrog-client-go/http/jfroghttpclient"
+	clientutils "github.com/jfrog/jfrog-client-go/utils"
 	"github.com/jfrog/jfrog-client-go/utils/errorutils"
 )
 
 type EntitlementsService struct {
-	client      *jfroghttpclient.JfrogHttpClient
-	XrayDetails auth.ServiceDetails
+	client          *jfroghttpclient.JfrogHttpClient
+	XrayDetails     auth.ServiceDetails
+	ScopeProjectKey string
 }
 
 // NewEntitlementsService creates a new service to retrieve the entitlement data from Xray
@@ -26,10 +28,14 @@ func (es *EntitlementsService) GetXrayDetails() auth.ServiceDetails {
 	return es.XrayDetails
 }
 
+func (es *EntitlementsService) getUrlForEntitlementApi(featureId string) string {
+	return clientutils.AppendScopedProjectKeyParam(es.XrayDetails.GetUrl()+"api/v1/entitlements/feature/"+featureId, es.ScopeProjectKey)
+}
+
 // IsEntitled returns true if the user is entitled for the requested feature ID
 func (es *EntitlementsService) IsEntitled(featureId string) (entitled bool, err error) {
 	httpDetails := es.XrayDetails.CreateHttpClientDetails()
-	resp, body, _, err := es.client.SendGet(es.XrayDetails.GetUrl()+"api/v1/entitlements/feature/"+featureId, true, &httpDetails)
+	resp, body, _, err := es.client.SendGet(es.getUrlForEntitlementApi(featureId), true, &httpDetails)
 	if err != nil {
 		err = errors.New("failed while attempting to get JFrog Xray entitlements response: " + err.Error())
 		return
@@ -40,7 +46,7 @@ func (es *EntitlementsService) IsEntitled(featureId string) (entitled bool, err
 	}
 	var userEntitlements entitlements
 	if err = json.Unmarshal(body, &userEntitlements); err != nil {
-		err = errorutils.CheckErrorf("couldn't parse JFrog Xray server entitlements response: " + err.Error())
+		err = errorutils.CheckErrorf("couldn't parse JFrog Xray server entitlements response: %s", err.Error())
 		return
 	}
 	entitled = userEntitlements.Entitled

xray/services/scan.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	clientUtils "github.com/jfrog/jfrog-client-go/utils"
+	clientutils "github.com/jfrog/jfrog-client-go/utils"
 	"github.com/jfrog/jfrog-client-go/utils/log"
 	xrayUtils "github.com/jfrog/jfrog-client-go/xray/services/utils"
 	xscUtils "github.com/jfrog/jfrog-client-go/xsc/services/utils"
@@ -54,8 +55,9 @@ const (
 type ScanType string
 
 type ScanService struct {
-	client      *jfroghttpclient.JfrogHttpClient
-	XrayDetails auth.ServiceDetails
+	client          *jfroghttpclient.JfrogHttpClient
+	XrayDetails     auth.ServiceDetails
+	ScopeProjectKey string
 }
 
 // NewScanService creates a new service to scan binaries and audit code projects' dependencies.
@@ -124,7 +126,7 @@ func (ss *ScanService) ScanGraph(scanParams XrayGraphScanParams) (string, error)
 		url = xscUtils.XrayUrlToXscUrl(ss.XrayDetails.GetUrl(), scanParams.XrayVersion) + XscGraphAPI
 	}
 	url += createScanGraphQueryParams(scanParams)
-	resp, body, err := ss.client.SendPost(url, requestBody, &httpClientsDetails)
+	resp, body, err := ss.client.SendPost(clientutils.AppendScopedProjectKeyParam(url, ss.ScopeProjectKey), requestBody, &httpClientsDetails)
 	if err != nil {
 		return "", err
 	}
@@ -168,7 +170,7 @@ func (ss *ScanService) GetScanGraphResults(scanId, xrayVersion string, includeVu
 	pollingExecutor := &httputils.PollingExecutor{
 		Timeout:         defaultMaxWaitMinutes,
 		PollingInterval: defaultSyncSleepInterval,
-		PollingAction:   xrayUtils.PollingAction(ss.client, endPoint, httpClientsDetails),
+		PollingAction:   xrayUtils.PollingAction(ss.client, clientutils.AppendScopedProjectKeyParam(endPoint, ss.ScopeProjectKey), httpClientsDetails),
 		MsgPrefix:       "Get Dependencies Scan results... ",
 	}
 

xray/services/xsc/xsc.go

@@ -10,8 +10,9 @@ import (
 // XscService is the Xray Source Control service in the Xray service, available from v3.107.13.
 // This service replaces the Xray Source Control service, which was available as a standalone service.
 type XscInnerService struct {
-	client      *jfroghttpclient.JfrogHttpClient
-	XrayDetails auth.ServiceDetails
+	client          *jfroghttpclient.JfrogHttpClient
+	XrayDetails     auth.ServiceDetails
+	ScopeProjectKey string
 }
 
 func NewXscService(client *jfroghttpclient.JfrogHttpClient) *XscInnerService {
@@ -27,41 +28,48 @@ func (xs *XscInnerService) GetVersion() (string, error) {
 func (xs *XscInnerService) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent, xrayVersion string) (string, error) {
 	eventService := services.NewAnalyticsEventService(xs.client)
 	eventService.XrayDetails = xs.XrayDetails
+	eventService.ScopeProjectKey = xs.ScopeProjectKey
 	return eventService.AddGeneralEvent(event, xrayVersion)
 }
 
 func (xs *XscInnerService) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error {
 	logErrorService := services.NewLogErrorEventService(xs.client)
 	logErrorService.XrayDetails = xs.XrayDetails
+	logErrorService.ScopeProjectKey = xs.ScopeProjectKey
 	return logErrorService.SendLogErrorEvent(errorLog)
 }
 
 func (xs *XscInnerService) UpdateAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEventFinalize) error {
 	eventService := services.NewAnalyticsEventService(xs.client)
 	eventService.XrayDetails = xs.XrayDetails
+	eventService.ScopeProjectKey = xs.ScopeProjectKey
 	return eventService.UpdateGeneralEvent(event)
 }
 
 func (xs *XscInnerService) GetAnalyticsGeneralEvent(msi string) (*services.XscAnalyticsGeneralEvent, error) {
 	eventService := services.NewAnalyticsEventService(xs.client)
 	eventService.XrayDetails = xs.XrayDetails
+	eventService.ScopeProjectKey = xs.ScopeProjectKey
 	return eventService.GetGeneralEvent(msi)
 }
 
 func (xs *XscInnerService) GetConfigProfileByName(profileName string) (*services.ConfigProfile, error) {
 	configProfileService := services.NewConfigurationProfileService(xs.client)
 	configProfileService.XrayDetails = xs.XrayDetails
+	configProfileService.ScopeProjectKey = xs.ScopeProjectKey
 	return configProfileService.GetConfigurationProfileByName(profileName)
 }
 
 func (xs *XscInnerService) GetConfigProfileByUrl(repoUrl string) (*services.ConfigProfile, error) {
 	configProfileService := services.NewConfigurationProfileService(xs.client)
 	configProfileService.XrayDetails = xs.XrayDetails
+	configProfileService.ScopeProjectKey = xs.ScopeProjectKey
 	return configProfileService.GetConfigurationProfileByUrl(repoUrl)
 }
 
 func (xs *XscInnerService) GetResourceWatches(gitRepo, project string) (watches *utils.ResourcesWatchesBody, err error) {
 	watchService := services.NewWatchService(xs.client)
 	watchService.XrayDetails = xs.XrayDetails
+	watchService.ScopeProjectKey = xs.ScopeProjectKey
 	return watchService.GetResourceWatches(gitRepo, project)
 }