Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 69 additions & 2 deletions internal/commands/telemetry.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
package commands

import (
"strings"

"github.com/MakeNowJust/heredoc"
"github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)

func NewTelemetryCommand(telemetryWrapper wrappers.TelemetryWrapper) *cobra.Command {
Expand All @@ -27,7 +30,7 @@
Long: "Collects telemetry data for user interactions related to AI features.",
Example: heredoc.Doc(
`
$ cx telemetry ai --ai-provider <AI Provider> --problem-severity <Problem Severity> --type<Event Type> --sub-type<Event Name> --agent <Agent> --engine <Engine>
$ cx telemetry ai --ai-provider <AI Provider> --problem-severity <Problem Severity> --type<Event Type> --sub-type<Event Name> --agent <Agent> --engine <Engine> --event-attributes "apiVersion=v2;vulnerabilityId=CVE-2021-44228;remediationMode=DevAssist"
`,
),

Expand All @@ -42,11 +45,47 @@
telemetryAICmd.PersistentFlags().String(params.AgentFlag, "", "Agent")
telemetryAICmd.PersistentFlags().String(params.ScanTypeFlag, "", "Scan Type")
telemetryAICmd.PersistentFlags().String(params.StatusFlag, "", "Status")
telemetryAICmd.PersistentFlags().String(params.StatusResultFlag, "", "Status Result")
telemetryAICmd.PersistentFlags().Int(params.TotalCountFlag, 0, "Total Count")
telemetryAICmd.PersistentFlags().String(params.AgentVersionFlag, "", "Agent Version")
telemetryAICmd.PersistentFlags().String(params.CxPluginVersionFlag, "", "CX Plugin Version")
telemetryAICmd.PersistentFlags().String(params.PluginTypeFlag, "", "Plugin Type")
telemetryAICmd.PersistentFlags().String(params.RepoURLFlag, "", "Repository URL")
telemetryAICmd.PersistentFlags().String(params.EventAttributesFlag, "", "Event Attributes in key=value;key=value format (e.g., apiVersion=v2;vulnerabilityId=CVE-2021-44228;remediationMode=DevAssist)")
telemetryAICmd.PersistentFlags().String(params.ApiVersionFlag, "", "API Version")

return telemetryAICmd
}

func parseEventAttributes(eventAttributesStr string) *wrappers.EventAttributes {
if eventAttributesStr == "" {
return nil
}

attrs := make(wrappers.EventAttributes)
pairs := strings.Split(eventAttributesStr, ";")

for _, pair := range pairs {
kv := strings.SplitN(pair, "=", 2)

Check failure on line 69 in internal/commands/telemetry.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

Magic number: 2, in <argument> detected (mnd)
if len(kv) != 2 {

Check failure on line 70 in internal/commands/telemetry.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

Magic number: 2, in <condition> detected (mnd)
continue
}

key := strings.TrimSpace(kv[0])
value := strings.TrimSpace(kv[1])

if key != "" {
attrs[key] = value
}
}

if len(attrs) == 0 {
return nil
}

return &attrs
}

func runTelemetryAI(telemetryWrapper wrappers.TelemetryWrapper) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, _ []string) error {
aiProvider, _ := cmd.Flags().GetString("ai-provider")
Expand All @@ -57,19 +96,47 @@
engine, _ := cmd.Flags().GetString("engine")
scanType, _ := cmd.Flags().GetString("scan-type")
status, _ := cmd.Flags().GetString("status")
totalCount, _ := cmd.Flags().GetInt("total-count")
totalCount, _ := cmd.Flags().GetInt(params.TotalCountFlag)
statusResult, _ := cmd.Flags().GetString(params.StatusResultFlag)
agentVersion, _ := cmd.Flags().GetString(params.AgentVersionFlag)
cxPluginVersion, _ := cmd.Flags().GetString(params.CxPluginVersionFlag)
pluginType, _ := cmd.Flags().GetString(params.PluginTypeFlag)
repoURL, _ := cmd.Flags().GetString(params.RepoURLFlag)
eventAttributesStr, _ := cmd.Flags().GetString(params.EventAttributesFlag)
apiVersion, _ := cmd.Flags().GetString(params.ApiVersionFlag)

uniqueID := wrappers.GetUniqueID()
machineUniqueId := wrappers.GetMachineID()

var sessionID string
if eventType == "authentication" && status == "success" {
sessionID = wrappers.GetSessionID()
} else {
sessionID = viper.GetString(params.SessionIDConfigKey)
}

eventAttrs := parseEventAttributes(eventAttributesStr)

err := telemetryWrapper.SendAIDataToLog(&wrappers.DataForAITelemetry{
AIProvider: aiProvider,
ProblemSeverity: problemSeverity,
Type: eventType,
SubType: subType,
Agent: agent,
AgentVersion: agentVersion,
CxPluginVersion: cxPluginVersion,
PluginType: pluginType,
Engine: engine,
ScanType: scanType,
Status: status,
StatusResult: statusResult,
APIVersion: apiVersion,
TotalCount: totalCount,
RepoURL: repoURL,
UniqueID: uniqueID,
SessionID: sessionID,
MachineUniqueId: machineUniqueId,
EventAttributes: eventAttrs,
})

if err != nil {
Expand Down
1 change: 1 addition & 0 deletions internal/params/envs.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ const (
ConfigFilePathEnv = "CX_CONFIG_FILE_PATH"
RealtimeScannerPathEnv = "CX_REALTIME_SCANNER_PATH"
UniqueIDEnv = "CX_UNIQUE_ID"
SessionIDEnv = "CX_SESSION_ID"
StartMultiPartUploadPathEnv = "CX_START_MULTIPART_UPLOAD_PATH"
MultipartPresignedPathEnv = "CX_MULTIPART_PRESIGNED_URL_PATH"
CompleteMultipartUploadPathEnv = "CX_COMPLETE_MULTIPART_UPLOAD_PATH"
Expand Down
8 changes: 7 additions & 1 deletion internal/params/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@ const (
SubTypeFlag = "sub-type"
EngineFlag = "engine"
StatusFlag = "status"
StatusResultFlag = "status-result"
scanTypeFlag = "scan-type"
TotalCountFlag = "total-count"
AgentVersionFlag = "agent-version"
CxPluginVersionFlag = "cx-plugin-version"
PluginTypeFlag = "plugin-type"
RepoURLFlag = "repo-url"
EventAttributesFlag = "event-attributes"
ApiVersionFlag = "api-version"
OriginFlag = "origin"
AgentFlagUsage = "Scan origin name"
ApplicationName = "application-name"
Expand Down Expand Up @@ -167,7 +174,6 @@ const (
URLFlagUsage = "API base URL"
QueryIDFlag = "query-id"
SSHKeyFlag = "ssh-key"
RepoURLFlag = "repo-url"
SSHValue = "ssh-value"
KicsContainerNameKey = "kics-container-name"
KicsPlatformsFlag = "kics-platforms"
Expand Down
1 change: 1 addition & 0 deletions internal/params/keys.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ var (
ConfigFilePathKey = strings.ToLower(ConfigFilePathEnv)
RealtimeScannerPathKey = strings.ToLower(RealtimeScannerPathEnv)
UniqueIDConfigKey = strings.ToLower(UniqueIDEnv)
SessionIDConfigKey = strings.ToLower(SessionIDEnv)
StartMultiPartUploadPathKey = strings.ToLower(StartMultiPartUploadPathEnv)
MultipartPresignedPathKey = strings.ToLower(MultipartPresignedPathEnv)
CompleteMultiPartUploadPathKey = strings.ToLower(CompleteMultipartUploadPathEnv)
Expand Down
111 changes: 110 additions & 1 deletion internal/wrappers/jwt-helper.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
package wrappers

import (
"bytes"
"os"
"os/exec"
"os/user"
"runtime"
"strconv"
"strings"

Expand Down Expand Up @@ -222,10 +226,14 @@

// Check if unique id is already set
uniqueID = viper.GetString(commonParams.UniqueIDConfigKey)
if uniqueID != "" {
if uniqueID != "" && isValidUniqueIDFormat(uniqueID) {
return uniqueID
}

if uniqueID != "" {
logger.PrintIfVerbose("Existing unique ID invalid format, regenerating")
}

// Generate new unique id
currentUser, err := user.Current()
if err != nil {
Expand All @@ -247,3 +255,104 @@
}
return uniqueID
}

func isValidUniqueIDFormat(uniqueID string) bool {
parts := strings.Split(uniqueID, "_")
if len(parts) != 2 {

Check failure on line 261 in internal/wrappers/jwt-helper.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

Magic number: 2, in <condition> detected (mnd)
return false
}

guid := parts[0]
storedUsername := parts[1]

if len(guid) != 36 {

Check failure on line 268 in internal/wrappers/jwt-helper.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

Magic number: 36, in <condition> detected (mnd)
return false
}

if _, err := uuid.Parse(guid); err != nil {
return false
}

if storedUsername == "" {
return false
}

currentUser, err := user.Current()
if err != nil {
return false
}
currentUsername := currentUser.Username
currentUsername = strings.TrimSpace(currentUsername)
if strings.Contains(currentUsername, "\\") {
currentUsername = strings.Split(currentUsername, "\\")[1]
}

if storedUsername != currentUsername {
return false
}

return true
}

func GetSessionID() string {
sessionID := uuid.New().String()
viper.Set(commonParams.SessionIDConfigKey, sessionID)
configFilePath, err := configuration.GetConfigFilePath()
if err != nil {
logger.PrintIfVerbose("Failed to get config file path: " + err.Error())
return sessionID
}

err = configuration.SafeWriteSingleConfigKeyString(configFilePath, commonParams.SessionIDConfigKey, sessionID)
if err != nil {
logger.PrintIfVerbose("Failed to write session ID config: " + err.Error())
}
return sessionID
}

func GetMachineID() string {
switch runtime.GOOS {
case "windows":
return getWindowsMachineID()
case "darwin":

Check failure on line 317 in internal/wrappers/jwt-helper.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

string `darwin` has 2 occurrences, make it a constant (goconst)
return getMacOSMachineID()
case "linux":
return getLinuxMachineID()
default:
return ""
}
}


Check failure on line 326 in internal/wrappers/jwt-helper.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

File is not properly formatted (gofmt)
func getMacOSMachineID() string {
buf := &bytes.Buffer{}
cmd := exec.Command("ioreg", "-rd1", "-c", "IOPlatformExpertDevice")
cmd.Stdout = buf
err := cmd.Run()
if err != nil {
logger.PrintIfVerbose("Failed to run ioreg: " + err.Error())
return ""
}
for _, line := range strings.Split(buf.String(), "\n") {
if strings.Contains(line, "IOPlatformUUID") {
parts := strings.SplitAfter(line, `" = "`)
if len(parts) == 2 {

Check failure on line 339 in internal/wrappers/jwt-helper.go

View workflow job for this annotation

GitHub Actions / Lint (golangci-lint)

Magic number: 2, in <condition> detected (mnd)
machineID := strings.TrimRight(parts[1], `"`)
return strings.TrimSpace(machineID)
}
}
}
return ""
}

func getLinuxMachineID() string {
machineID, err := os.ReadFile("/var/lib/dbus/machine-id")
if err == nil {
return strings.TrimSpace(string(machineID))
}
machineID, err = os.ReadFile("/etc/machine-id")
if err == nil {
return strings.TrimSpace(string(machineID))
}
return ""
}
Loading
Loading