Files
trufflehog/pkg/detectors/telegrambottoken/telegrambottoken.go
Dustin Decker 14e44db2be Move detectors.IsKnownFalsePositive from the detectors and into the engine (#2643)
* 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
2024-04-22 15:18:04 -07:00

100 lines
2.6 KiB
Go

package telegrambottoken
import (
"context"
"encoding/json"
// "fmt"
regexp "github.com/wasilibs/go-re2"
"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{}
// Ensure the Scanner satisfies the interface at compile time.
var _ detectors.Detector = (*Scanner)(nil)
var (
client = common.SaneHttpClient()
// https://core.telegram.org/bots#6-botfather
// thanks https://stackoverflow.com/questions/61868770/tegram-bot-api-token-format
keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"telegram", "tgram://"}) + `\b([0-9]{8,10}:[a-zA-Z0-9_-]{35})\b`)
)
// Keywords are used for efficiently pre-filtering chunks.
// Use identifiers in the secret preferably, or the provider name.
func (s Scanner) Keywords() []string {
// Apprise uses the `tgram://` url scheme.
// https://github.com/caronc/apprise/wiki/Notify_telegram
return []string{"telegram", "tgram"}
}
// FromData will find and optionally verify TelegramBotToken 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
}
key := strings.TrimSpace(match[1])
s1 := detectors.Result{
DetectorType: detectorspb.DetectorType_TelegramBotToken,
Raw: []byte(key),
}
if verify {
// https://core.telegram.org/bots/api#getme
req, err := http.NewRequestWithContext(ctx, "GET", "https://api.telegram.org/bot"+key+"/getMe", nil)
if err != nil {
continue
}
res, err := client.Do(req)
if err == nil {
defer res.Body.Close()
if res.StatusCode >= 200 && res.StatusCode < 300 {
s1.Verified = true
apiRes := apiResponse{}
err := json.NewDecoder(res.Body).Decode(&apiRes)
if err == nil && apiRes.Ok {
s1.ExtraData = map[string]string{
"username": apiRes.Result.Username,
}
}
}
}
}
results = append(results, s1)
}
return results, nil
}
// https://core.telegram.org/bots/api#making-requests
type apiResponse struct {
Ok bool `json:"ok"`
Result *userResponse `json:"result"`
}
// https://core.telegram.org/bots/api#user
type userResponse struct {
IsBot bool `json:"is_bot"`
Username string `json:"username"`
}
func (s Scanner) Type() detectorspb.DetectorType {
return detectorspb.DetectorType_TelegramBotToken
}