package mongodb import ( "context" "errors" "net/url" "strings" "time" logContext "github.com/trufflesecurity/trufflehog/v3/pkg/context" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" regexp "github.com/wasilibs/go-re2" "go.mongodb.org/mongo-driver/mongo" "go.mongodb.org/mongo-driver/mongo/options" "go.mongodb.org/mongo-driver/mongo/readpref" "go.mongodb.org/mongo-driver/x/mongo/driver/auth" ) type Scanner struct { timeout time.Duration // Zero value means "default timeout" } // Ensure the Scanner satisfies the interface at compile time. var _ detectors.Detector = (*Scanner)(nil) var _ detectors.CustomFalsePositiveChecker = (*Scanner)(nil) var ( defaultTimeout = 5 * time.Second // Make sure that your group is surrounded in boundary characters such as below to reduce false positives. connStrPat = regexp.MustCompile(`\b(mongodb(?:\+srv)?://(?P\S{3,50}):(?P\S{3,88})@(?P[-.%\w]+(?::\d{1,5})?(?:,[-.%\w]+(?::\d{1,5})?)*)(?:/(?P[\w-]+)?(?P\?\w+=[\w@/.$-]+(?:&(?:amp;)?\w+=[\w@/.$-]+)*)?)?)(?:\b|$)`) // TODO: Add support for sharded cluster, replica set and Atlas Deployment. placeholderPasswordPat = regexp.MustCompile(`^[xX]+|\*+$`) ) // 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{"mongodb"} } // FromData will find and optionally verify MongoDB secrets in a given set of bytes. func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) { logger := logContext.AddLogger(ctx).Logger().WithName("mongodb") dataStr := string(data) uniqueMatches := make(map[string]string) for _, match := range connStrPat.FindAllStringSubmatch(dataStr, -1) { // Filter out common placeholder passwords. password := match[3] if password == "" || placeholderPasswordPat.MatchString(password) { continue } // If the query string contains `&` the options will not be parsed. connStr := strings.Replace(strings.TrimSpace(match[1]), "&", "&", -1) connUrl, err := url.Parse(connStr) if err != nil { logger.V(3).Info("Skipping invalid URL", "err", err) continue } params := connUrl.Query() for k, v := range connUrl.Query() { if len(v) > 0 { switch k { case "tls": if v[0] == "false" { params.Set("tls", "false") } else { params.Set("tls", "true") } } } } connUrl.RawQuery = params.Encode() connStr = connUrl.String() uniqueMatches[connStr] = password } for connStr, password := range uniqueMatches { r := detectors.Result{ DetectorType: detectorspb.DetectorType_MongoDB, Raw: []byte(connStr), ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/mongo/", }, } if verify { timeout := s.timeout if timeout == 0 { timeout = defaultTimeout } isVerified, vErr := verifyUri(ctx, connStr, timeout) r.Verified = isVerified if isErrDeterminate(vErr) { continue } r.SetVerificationError(vErr, password) } results = append(results, r) } return results, nil } func (s Scanner) IsFalsePositive(_ detectors.Result) (bool, string) { return false, "" } func (s Scanner) Description() string { return "MongoDB is a NoSQL database that uses a document-oriented data model. MongoDB credentials can be used to access and manipulate the database." } func isErrDeterminate(err error) bool { var authErr *auth.Error return errors.As(err, &authErr) } func verifyUri(ctx context.Context, connStr string, timeout time.Duration) (bool, error) { ctx, cancel := context.WithTimeout(ctx, timeout) defer cancel() clientOptions := options.Client().SetTimeout(timeout).ApplyURI(connStr) if err := clientOptions.Validate(); err != nil { return false, err } client, err := mongo.Connect(ctx, clientOptions) if err != nil { return false, err } defer func() { _ = client.Disconnect(ctx) }() err = client.Ping(ctx, readpref.Primary()) return err == nil, err } func (s Scanner) Type() detectorspb.DetectorType { return detectorspb.DetectorType_MongoDB }