package boostnote import ( "context" "fmt" "io" "net/http" "strings" 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{} // Ensure the Scanner satisfies the interface at compile time. var _ detectors.Detector = (*Scanner)(nil) var ( client = 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{"boostnote"}) + `\b([0-9a-f]{64})\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{"boostnote"} } // FromData will find and optionally verify BoostNote 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 { resMatch := strings.TrimSpace(match[1]) s1 := detectors.Result{ DetectorType: detector_typepb.DetectorType_BoostNote, Raw: []byte(resMatch), SecretParts: map[string]string{"key": resMatch}, } if verify { isVerified, verificationErr := verifyBoostnote(ctx, client, resMatch) s1.Verified = isVerified s1.SetVerificationError(verificationErr) } results = append(results, s1) } return results, nil } func (s Scanner) Type() detector_typepb.DetectorType { return detector_typepb.DetectorType_BoostNote } func (s Scanner) Description() string { return "BoostNote is a note-taking application. The secret detected here is likely an API key or token used to access BoostNote services." } // docs: https://boostnote.io/features/public-api func verifyBoostnote(ctx context.Context, client *http.Client, key string) (bool, error) { req, err := http.NewRequestWithContext(ctx, "GET", "https://boostnote.io/api/docs", nil) if err != nil { return false, err } req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", key)) resp, err := client.Do(req) if err != nil { return false, err } defer func() { _, _ = io.Copy(io.Discard, resp.Body) _ = resp.Body.Close() }() switch resp.StatusCode { case http.StatusOK: return true, nil case http.StatusUnauthorized: return false, nil default: return false, fmt.Errorf("unexpected status code: %d", resp.StatusCode) } }