Miccah
ad2f9a4b98
* Populate SecretParts on single-part detectors
Adds SecretParts: map[string]string{"key": <secret>} to every detector
package that constructs detectors.Result with a single captured secret
value. This is the single-part half of the SecretParts migration (the
linter's common case, ~695 packages).
* Populate SecretParts on multi-part detectors
122 lines
3.3 KiB
Go
122 lines
3.3 KiB
Go
package sonarcloud
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
|
|
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 {
|
|
client *http.Client
|
|
}
|
|
|
|
// Ensure the Scanner satisfies the interface at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
|
|
var (
|
|
defaultClient = 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{"sonar"}) + `(?:^|[^@])\b([0-9a-z]{40})\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{"sonar"}
|
|
}
|
|
|
|
func (s Scanner) getClient() *http.Client {
|
|
if s.client != nil {
|
|
return s.client
|
|
}
|
|
|
|
return defaultClient
|
|
}
|
|
|
|
// FromData will find and optionally verify SonarCloud 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)
|
|
|
|
uniqueTokenMatches := make(map[string]struct{})
|
|
for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) {
|
|
uniqueTokenMatches[match[1]] = struct{}{}
|
|
}
|
|
|
|
for match := range uniqueTokenMatches {
|
|
s1 := detectors.Result{
|
|
DetectorType: detector_typepb.DetectorType_SonarCloud,
|
|
Raw: []byte(match),
|
|
SecretParts: map[string]string{"key": match},
|
|
}
|
|
|
|
if verify {
|
|
isVerified, verificationErr := s.verifyMatch(ctx, s.getClient(), match)
|
|
s1.Verified = isVerified
|
|
s1.SetVerificationError(verificationErr, match)
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
// verifyMatch attempts to validate a SonarCloud token.
|
|
func (s Scanner) verifyMatch(ctx context.Context, client *http.Client, token string) (bool, error) {
|
|
url := "https://sonarcloud.io/api/authentication/validate"
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, http.NoBody)
|
|
if err != nil {
|
|
return false, fmt.Errorf("failed to create request: %w", err)
|
|
}
|
|
|
|
req.SetBasicAuth(token, "")
|
|
res, err := client.Do(req)
|
|
if err != nil {
|
|
return false, fmt.Errorf("failed to perform request: %w", err)
|
|
}
|
|
|
|
defer func() {
|
|
_, _ = io.Copy(io.Discard, res.Body)
|
|
_ = res.Body.Close()
|
|
}()
|
|
|
|
// The SonarCloud API always returns 200 OK, even for invalid tokens,
|
|
// with the validity indicated in the JSON body.
|
|
if res.StatusCode != http.StatusOK {
|
|
// Treat any non-200 status as a failed attempt to verify.
|
|
return false, fmt.Errorf("unexpected status code: %d", res.StatusCode)
|
|
}
|
|
|
|
bodyBytes, err := io.ReadAll(res.Body)
|
|
if err != nil {
|
|
return false, fmt.Errorf("failed to read response body: %w", err)
|
|
}
|
|
|
|
var resp struct {
|
|
Valid bool `json:"valid"`
|
|
}
|
|
|
|
if err := json.Unmarshal(bodyBytes, &resp); err != nil {
|
|
return false, fmt.Errorf("invalid JSON: %w", err)
|
|
}
|
|
|
|
return resp.Valid, nil
|
|
}
|
|
|
|
func (s Scanner) Type() detector_typepb.DetectorType {
|
|
return detector_typepb.DetectorType_SonarCloud
|
|
}
|
|
|
|
func (s Scanner) Description() string {
|
|
return "SonarCloud is a cloud-based code quality and security service. SonarCloud tokens can be used to access project analysis and quality reports."
|
|
}
|