forked from trufflesecurity/trufflehog
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Couchbase Detector (trufflesecurity#1385)
* init * add detector type * rotate leaked credentials * tighten up username pattern * isolated prefixregex as overrriding new line stuff * passwordPat working now * add username test * fix edge case * cleanup * make linter happy * make linter happy rd 2 * skip error logging * fix test * add password regex helper func * make test more robust * cleanup PR * remove comments * clarify prepend rationale
- Loading branch information
Showing
8 changed files
with
384 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| package common | ||
|
|
||
| import ( | ||
| "github.com/stretchr/testify/assert" | ||
| "regexp" | ||
| "testing" | ||
| ) | ||
|
|
||
| const ( | ||
| usernamePattern = `?()/\+=\s\n` | ||
| passwordPattern = `^<>;.*&|£\n\s` | ||
| usernameRegex = `(?im)(?:user|usr)\S{0,40}?[:=\s]{1,3}[ '"=]{0,1}([^:?()/\+=\s\n]{4,40})\b` | ||
| passwordRegex = `(?im)(?:pass|password)\S{0,40}?[:=\s]{1,3}[ '"=]{0,1}([^:^<>;.*&|£\n\s]{4,40})` | ||
| ) | ||
|
|
||
| func TestUsernameRegexCheck(t *testing.T) { | ||
| usernameRegexPat := UsernameRegexCheck(usernamePattern) | ||
|
|
||
| expectedRegexPattern := regexp.MustCompile(usernameRegex) | ||
|
|
||
| if usernameRegexPat.compiledRegex.String() != expectedRegexPattern.String() { | ||
| t.Errorf("\n got %v \n want %v", usernameRegexPat.compiledRegex, expectedRegexPattern) | ||
| } | ||
|
|
||
| testString := `username = "johnsmith123" | ||
| username='johnsmith123' | ||
| username:="johnsmith123" | ||
| username = johnsmith123 | ||
| username=johnsmith123` | ||
|
|
||
| expectedStr := []string{"johnsmith123", "johnsmith123", "johnsmith123", "johnsmith123", "johnsmith123"} | ||
|
|
||
| usernameRegexMatches := usernameRegexPat.Matches([]byte(testString)) | ||
|
|
||
| assert.Exactly(t, usernameRegexMatches, expectedStr) | ||
|
|
||
| } | ||
|
|
||
| func TestPasswordRegexCheck(t *testing.T) { | ||
| passwordRegexPat := PasswordRegexCheck(passwordPattern) | ||
|
|
||
| expectedRegexPattern := regexp.MustCompile(passwordRegex) | ||
| assert.Equal(t, passwordRegexPat.compiledRegex, expectedRegexPattern) | ||
|
|
||
| testString := `password = "johnsmith123$!" | ||
| password='johnsmith123$!' | ||
| password:="johnsmith123$!" | ||
| password = johnsmith123$! | ||
| password=johnsmith123$! | ||
| PasswordAuthenticator(username, "johnsmith123$!")` | ||
|
|
||
| expectedStr := []string{"johnsmith123$!", "johnsmith123$!", "johnsmith123$!", "johnsmith123$!", "johnsmith123$!", | ||
| "johnsmith123$!"} | ||
|
|
||
| passwordRegexMatches := passwordRegexPat.Matches([]byte(testString)) | ||
|
|
||
| assert.Exactly(t, passwordRegexMatches, expectedStr) | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| package couchbase | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "log" | ||
| "regexp" | ||
| "strings" | ||
| "time" | ||
| "unicode" | ||
|
|
||
| "github.com/couchbase/gocb/v2" | ||
| "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{} | ||
|
|
||
| // Ensure the Scanner satisfies the interface at compile time. | ||
| var _ detectors.Detector = (*Scanner)(nil) | ||
|
|
||
| var ( | ||
|
|
||
| // Make sure that your group is surrounded in boundary characters such as below to reduce false positives. | ||
| connectionStringPat = regexp.MustCompile(`\bcb\.[a-z0-9]+\.cloud\.couchbase\.com\b`) | ||
| usernamePat = `?()/\+=\s\n` | ||
| passwordPat = `^<>;.*&|£\n\s` | ||
| //passwordPat = regexp.MustCompile(`(?i)(?:pass|pwd)(?:.|[\n\r]){0,15}(\b[^<>;.*&|£\n\s]{8,100}$)`) | ||
| // passwordPat = regexp.MustCompile(`(?im)(?:pass|pwd)\S{0,40}?[:=\s]{1,3}[ '"=]{0,1}([^:?()/\+=\s\n]{4,40})\b`) | ||
| ) | ||
|
|
||
| func meetsCouchbasePasswordRequirements(password string) (string, bool) { | ||
| var hasLower, hasUpper, hasNumber, hasSpecialChar bool | ||
| for _, char := range password { | ||
| switch { | ||
| case unicode.IsLower(char): | ||
| hasLower = true | ||
| case unicode.IsUpper(char): | ||
| hasUpper = true | ||
| case unicode.IsNumber(char): | ||
| hasNumber = true | ||
| case unicode.IsPunct(char) || unicode.IsSymbol(char): | ||
| hasSpecialChar = true | ||
| } | ||
|
|
||
| if hasLower && hasUpper && hasNumber && hasSpecialChar { | ||
| return password, true | ||
| } | ||
| } | ||
|
|
||
| return "", false | ||
| } | ||
|
|
||
| // 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{"couchbase://", "couchbases://"} | ||
| } | ||
|
|
||
| // FromData will find and optionally verify Couchbase 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) | ||
|
|
||
| connectionStringMatches := connectionStringPat.FindAllStringSubmatch(dataStr, -1) | ||
|
|
||
| // prepend 'couchbases://' to the connection string as the connection | ||
| // string format is couchbases://cb.stuff.cloud.couchbase.com but the | ||
| // cb.stuff.cloud.couchbase.com may be separated from the couchbases:// in codebases. | ||
| for i, connectionStringMatch := range connectionStringMatches { | ||
| connectionStringMatches[i][0] = "couchbases://" + connectionStringMatch[0] | ||
| } | ||
|
|
||
| usernameRegexState := common.UsernameRegexCheck(usernamePat) | ||
| usernameMatches := usernameRegexState.Matches(data) | ||
|
|
||
| passwordRegexState := common.PasswordRegexCheck(passwordPat) | ||
| passwordMatches := passwordRegexState.Matches(data) | ||
|
|
||
| for _, connectionStringMatch := range connectionStringMatches { | ||
| resConnectionStringMatch := strings.TrimSpace(connectionStringMatch[0]) | ||
|
|
||
| for _, resUsernameMatch := range usernameMatches { | ||
|
|
||
| for _, resPasswordMatch := range passwordMatches { | ||
| _, metPasswordRequirements := meetsCouchbasePasswordRequirements(resPasswordMatch) | ||
|
|
||
| if !metPasswordRequirements { | ||
| continue | ||
| } | ||
|
|
||
| s1 := detectors.Result{ | ||
| DetectorType: detectorspb.DetectorType_Couchbase, | ||
| Raw: []byte(fmt.Sprintf("%s:%s@%s", resUsernameMatch, resPasswordMatch, resConnectionStringMatch)), | ||
| } | ||
|
|
||
| if verify { | ||
|
|
||
| options := gocb.ClusterOptions{ | ||
| Authenticator: gocb.PasswordAuthenticator{ | ||
| Username: resUsernameMatch, | ||
| Password: resPasswordMatch, | ||
| }, | ||
| } | ||
|
|
||
| // Sets a pre-configured profile called "wan-development" to help avoid latency issues | ||
| // when accessing Capella from a different Wide Area Network | ||
| // or Availability Zone (e.g. your laptop). | ||
| if err := options.ApplyProfile(gocb.ClusterConfigProfileWanDevelopment); err != nil { | ||
| log.Fatal("apply profile err", err) | ||
| } | ||
|
|
||
| // Initialize the Connection | ||
| cluster, err := gocb.Connect(resConnectionStringMatch, options) | ||
| if err != nil { | ||
| continue | ||
| } | ||
|
|
||
| // We'll ping the KV nodes in our cluster. | ||
| pings, err := cluster.Ping(&gocb.PingOptions{ | ||
| Timeout: time.Second * 5, | ||
| }) | ||
|
|
||
| if err != nil { | ||
| continue | ||
| } | ||
|
|
||
| for _, ping := range pings.Services { | ||
| for _, pingEndpoint := range ping { | ||
| if pingEndpoint.State == gocb.PingStateOk { | ||
| s1.Verified = true | ||
| break | ||
| } else { | ||
| // This function will check false positives for common test words, but also it will make sure the key appears 'random' enough to be a real key. | ||
| if detectors.IsKnownFalsePositive(resPasswordMatch, detectors.DefaultFalsePositives, true) { | ||
| continue | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| results = append(results, s1) | ||
| } | ||
| } | ||
| } | ||
| return results, nil | ||
| } | ||
|
|
||
| func (s Scanner) Type() detectorspb.DetectorType { | ||
| return detectorspb.DetectorType_Couchbase | ||
| } |
Oops, something went wrong.