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
113 lines
3.3 KiB
Go
113 lines
3.3 KiB
Go
package launchdarkly
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"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/detectorspb"
|
|
|
|
ldclient "github.com/launchdarkly/go-server-sdk/v7"
|
|
"github.com/launchdarkly/go-server-sdk/v7/ldcomponents"
|
|
)
|
|
|
|
type Scanner struct {
|
|
client *http.Client
|
|
}
|
|
|
|
// Ensure the Scanner satisfies the interface at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
|
|
var (
|
|
defaultClient = common.SaneHttpClient()
|
|
defaultSDKConfig = ldclient.Config{
|
|
Logging: ldcomponents.NoLogging(),
|
|
}
|
|
defaultSDKTimeout = 10 * time.Second
|
|
invalidSDKKeyError = "SDK key contains invalid characters"
|
|
|
|
// Launchdarkly keys are UUIDv4s with either api- or sdk- prefixes.
|
|
// mob- keys are possible, but are not sensitive credentials.
|
|
keyPat = regexp.MustCompile(`\b((?:api|sdk)-[a-z0-9]{8}-[a-z0-9]{4}-4[a-z0-9]{3}-[a-z0-9]{4}-[a-z0-9]{12})\b`)
|
|
)
|
|
|
|
// We are not including "mob-" because client keys are not sensitive.
|
|
// They are expected to be public.
|
|
func (s Scanner) Keywords() []string {
|
|
return []string{"api-", "sdk-"}
|
|
}
|
|
|
|
// FromData will find and optionally verify LaunchDarkly 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_LaunchDarkly,
|
|
Raw: []byte(resMatch),
|
|
}
|
|
|
|
if verify {
|
|
if strings.HasPrefix(resMatch, "api-") {
|
|
req, err := http.NewRequestWithContext(ctx, "GET", "https://app.launchdarkly.com/api/v2/tokens", nil)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
client := s.client
|
|
if client == nil {
|
|
client = defaultClient
|
|
}
|
|
req.Header.Add("Authorization", resMatch)
|
|
res, err := client.Do(req)
|
|
if err == nil {
|
|
defer res.Body.Close()
|
|
if res.StatusCode >= 200 && res.StatusCode < 300 {
|
|
s1.Verified = true
|
|
} else if res.StatusCode == 401 {
|
|
// 401 is expected for an invalid token, so there is nothing to do here.
|
|
} else {
|
|
err = fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
|
|
s1.SetVerificationError(err, resMatch)
|
|
}
|
|
} else {
|
|
s1.SetVerificationError(err, resMatch)
|
|
}
|
|
} else {
|
|
// This is a server SDK key. Try to initialize using the SDK.
|
|
_, err := ldclient.MakeCustomClient(resMatch, defaultSDKConfig, defaultSDKTimeout)
|
|
if err == nil {
|
|
s1.Verified = true
|
|
} else if errors.Is(err, ldclient.ErrInitializationFailed) || err.Error() == invalidSDKKeyError {
|
|
// If initialization fails, the key is not valid, so do nothing.
|
|
} else {
|
|
// If the error isn't nil or known, then this is likely a timeout error: ldclient.ErrInitializationTimeout
|
|
// But any other error here means we don't know if this key is valid.
|
|
s1.SetVerificationError(err, resMatch)
|
|
}
|
|
}
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
func (s Scanner) Type() detectorspb.DetectorType {
|
|
return detectorspb.DetectorType_LaunchDarkly
|
|
}
|