Dustin Decker
14e44db2be
* Remove detectors.IsKnownFalsePositive from detectors * Centralize false positive removal in engine * Don't apply fp filtering on custom regex to preserve previous behavior. * fix empty branch * update excludes * update filtering * Add result flag option and exclude some detectors
132 lines
3.1 KiB
Go
132 lines
3.1 KiB
Go
package sentrytoken
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
regexp "github.com/wasilibs/go-re2"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
|
|
)
|
|
|
|
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{"sentry"}) + `\b([a-f0-9]{64})\b`)
|
|
|
|
errUnauthorized = fmt.Errorf("token unauthorized")
|
|
)
|
|
|
|
// 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{"sentry"}
|
|
}
|
|
|
|
// FromData will find and optionally verify SentryToken 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 {
|
|
if len(match) != 2 {
|
|
continue
|
|
}
|
|
resMatch := strings.TrimSpace(match[1])
|
|
s1 := detectors.Result{
|
|
DetectorType: detectorspb.DetectorType_SentryToken,
|
|
Raw: []byte(resMatch),
|
|
}
|
|
|
|
if verify {
|
|
client := s.client
|
|
if client == nil {
|
|
client = defaultClient
|
|
}
|
|
isVerified, verificationErr := verifyToken(ctx, client, resMatch)
|
|
|
|
switch {
|
|
case errors.Is(verificationErr, errUnauthorized):
|
|
s1.Verified = false
|
|
case isVerified:
|
|
s1.Verified = true
|
|
default:
|
|
s1.SetVerificationError(verificationErr, resMatch)
|
|
}
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
type Response []Project
|
|
|
|
type Project struct {
|
|
Organization Organization `json:"organization"`
|
|
}
|
|
|
|
type Organization struct {
|
|
ID string `json:"id"`
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
func verifyToken(ctx context.Context, client *http.Client, token string) (bool, error) {
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://sentry.io/api/0/projects/", nil)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", token))
|
|
|
|
res, err := client.Do(req)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
var isVerified bool
|
|
switch res.StatusCode {
|
|
case http.StatusOK, http.StatusForbidden:
|
|
isVerified = true
|
|
case http.StatusUnauthorized:
|
|
return false, errUnauthorized
|
|
default:
|
|
return false, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
|
|
}
|
|
|
|
bytes, readErr := io.ReadAll(res.Body)
|
|
if readErr != nil {
|
|
return false, readErr
|
|
}
|
|
|
|
var resp Response
|
|
if err = json.Unmarshal(bytes, &resp); err != nil {
|
|
return false, err
|
|
}
|
|
if len(resp) == 0 {
|
|
return false, fmt.Errorf("unexpected response body: %s", string(bytes))
|
|
}
|
|
|
|
return isVerified, err
|
|
}
|
|
|
|
func (s Scanner) Type() detectorspb.DetectorType {
|
|
return detectorspb.DetectorType_SentryToken
|
|
}
|