github-vet / github-vet/rangeloop-pointer-findings

davehammers/go_ztpplus: client/fsm/fsmDiscover.go; 25 LoC

Open
#13,055 0 comments 0 reactions 0 assignees View on GitHub
fresh small
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
PR metrics pending

Description

Found a possible issue in [davehammers/go_ztpplus](https://www.github.com/davehammers/go_ztpplus) at [client/fsm/fsmDiscover.go](https://github.com/davehammers/go_ztpplus/blob/c514c50570758845020241b46335d242a1261394/client/fsm/fsmDiscover.go#L29-L53)

Below is the message reported by the analyzer for this snippet of code. Beware that the analyzer only reports the first issue it finds, so please do not limit your consideration to the contents of the below message.

>

[Click here to see the code in its original context.](https://github.com/davehammers/go_ztpplus/blob/c514c50570758845020241b46335d242a1261394/client/fsm/fsmDiscover.go#L29-L53)

Click here to show the 25 line(s) of Go which triggered the analyzer.

```go
for _, hostPort := range *controllerList {
url := fmt.Sprintf("https://%s%s/device/v1/", hostPort.Host, hostPort.Port)
if hostPort.AddClientPrefix {
url = fmt.Sprintf("https://%s%s/Clients/device/v1/", hostPort.Host, hostPort.Port)
}
if DEBUG {
log.Println(url + "discovery")
}
resp, err = zc.httpClient.Get(url + "discovery")

// Tell the device
switch zc.Device.DiscoverResponse(err, resp, &hostPort) {
case DeviceReturnOK:
zc.urlPrefix = fmt.Sprintf("%s%s/%s/", url, zc.devType, zc.devID)
return ZtpStateConnect
case DeviceReturnRestart:
return ZtpStateReDiscoverPause
case DeviceReturnRetry:
continue
case DeviceReturnFinish:
return ZtpStateDone
case DeviceReturnAbort:
return ZtpStateReDiscoverPause
}
}

```

Click here to show extra information the analyzer produced.

```
No path was found through the callgraph that could lead to a function which writes a pointer argument.

No path was found through the callgraph that could lead to a function which passes a pointer to third-party code.

root signature {DiscoverResponse 3} was not found in the callgraph; reference was passed directly to third-party code
```

Leave a reaction on this issue to contribute to the project by classifying this instance as a **Bug** :-1:, **Mitigated** :+1:, or **Desirable Behavior** :rocket:
See the descriptions of the classifications [here](https://github.com/github-vet/rangeclosure-findings#how-can-i-help) for more information.

commit ID: c514c50570758845020241b46335d242a1261394

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading client/fsm/fsmDiscover.go at the linked lines, then inspect Device.DiscoverResponse and the surrounding FSM flow. Determine whether the range variable's address can escape or be passed to third-party code, and classify the analyzer finding as Bug, Mitigated, or Desirable Behavior using a reaction.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.