Shahzad Haider
cba3a0def2
Addresses review feedback on the per-detector commits.
- Rename the extracted verification function to verifyMatch in all 45
detectors. The branch had introduced a per-detector name (verifyCexIO,
verifyWhoxy, ...); verifyMatch is the established convention in this
package and each detector is its own package, so there is no collision.
- gengo and gocanvas were still swallowing the body-read error: a failed
io.ReadAll fell through to `return false, nil` and recorded nothing.
That is the bug this branch exists to fix, so both now return the error.
- Move `defer res.Body.Close()` above io.ReadAll and drain the body first
in the 13 detectors where the deferred close sat after the read, which
left the body unclosed on the error return: commodities, convier,
cryptocompare, dareboost, flowflu, getemail, holistic, raven,
reallysimplesystems, simfin, tefter, teletype, uptimerobot.
- fixerio deferred res.Body.Close() twice; drop the second.
- getemail and teletype had an empty if-branch with the work in the else,
left behind when the redundant `Verified = false` assignment was
removed. Inverted to `if !cond { return true, nil }`.
Status-code interpretation is still carried over verbatim and is not
touched here.
98 lines
2.6 KiB
Go
98 lines
2.6 KiB
Go
package commodities
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
regexp "github.com/wasilibs/go-re2"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detector_typepb"
|
|
)
|
|
|
|
type Scanner struct{}
|
|
|
|
// Ensure the Scanner satisfies the interface at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
|
|
var (
|
|
client = common.SaneHttpClient()
|
|
|
|
// Make sure that your group is surrounded in boundary characters such as below to reduce false positives.
|
|
keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"commodities"}) + `\b([a-zA-Z0-9]{60})\b`)
|
|
)
|
|
|
|
// Keywords are used for efficiently pre-filtering chunks.
|
|
// Use identifiers in the secret preferably, or the provider name.
|
|
func (s Scanner) Keywords() []string {
|
|
return []string{"commodities"}
|
|
}
|
|
|
|
// FromData will find and optionally verify Commodities secrets in a given set of bytes.
|
|
func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) {
|
|
dataStr := string(data)
|
|
|
|
matches := keyPat.FindAllStringSubmatch(dataStr, -1)
|
|
|
|
for _, match := range matches {
|
|
resMatch := strings.TrimSpace(match[1])
|
|
|
|
s1 := detectors.Result{
|
|
DetectorType: detector_typepb.DetectorType_Commodities,
|
|
Raw: []byte(resMatch),
|
|
SecretParts: map[string]string{"key": resMatch},
|
|
}
|
|
|
|
if verify {
|
|
isVerified, verificationErr := verifyMatch(ctx, client, resMatch)
|
|
s1.Verified = isVerified
|
|
s1.SetVerificationError(verificationErr, resMatch)
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
func verifyMatch(ctx context.Context, client *http.Client, resMatch string) (bool, error) {
|
|
client.Timeout = 5 * time.Second
|
|
req, err := http.NewRequestWithContext(ctx, "GET", "https://commodities-api.com/api/latest?access_key="+resMatch, nil)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
res, err := client.Do(req)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
defer func() {
|
|
_, _ = io.Copy(io.Discard, res.Body)
|
|
_ = res.Body.Close()
|
|
}()
|
|
bodyBytes, err := io.ReadAll(res.Body)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
bodyString := string(bodyBytes)
|
|
validResponse := strings.Contains(bodyString, `"success":true`)
|
|
if res.StatusCode >= 200 && res.StatusCode < 300 {
|
|
if validResponse {
|
|
return true, nil
|
|
}
|
|
}
|
|
|
|
return false, nil
|
|
}
|
|
|
|
func (s Scanner) Type() detector_typepb.DetectorType {
|
|
return detector_typepb.DetectorType_Commodities
|
|
}
|
|
|
|
func (s Scanner) Description() string {
|
|
return "Commodities API keys can be used to access and modify commodity data."
|
|
}
|