package github_oauth2 import ( "context" "strings" regexp "github.com/wasilibs/go-re2" "golang.org/x/oauth2/clientcredentials" "golang.org/x/oauth2/github" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" ) type Scanner struct { detectors.DefaultMultiPartCredentialProvider } // Ensure the Scanner satisfies the interfaces at compile time. var _ detectors.Detector = (*Scanner)(nil) var ( // Oauth2 client ID and secret oauth2ClientIDPat = regexp.MustCompile(detectors.PrefixRegex([]string{"github"}) + `\b([a-zA-Z0-9]{20})\b`) oauth2ClientSecretPat = regexp.MustCompile(detectors.PrefixRegex([]string{"github"}) + `\b([a-f0-9]{40})\b`) ) const ( githubBadVerificationCodeError = "bad_verification_code" ) // 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{"github"} } // FromData will find and optionally verify GitHub 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) // Oauth2 client ID and secret oauth2ClientIDMatches := oauth2ClientIDPat.FindAllStringSubmatch(dataStr, -1) oauth2ClientSecretMatches := oauth2ClientSecretPat.FindAllStringSubmatch(dataStr, -1) for _, idMatch := range oauth2ClientIDMatches { for _, secretMatch := range oauth2ClientSecretMatches { s1 := detectors.Result{ DetectorType: detectorspb.DetectorType_GitHubOauth2, Raw: []byte(idMatch[1]), RawV2: []byte(idMatch[1] + secretMatch[1]), } s1.ExtraData = map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/github/", } config := &clientcredentials.Config{ ClientID: idMatch[1], ClientSecret: secretMatch[1], TokenURL: github.Endpoint.TokenURL, } if verify { _, err := config.Token(ctx) // if client id and client secret is correct, it will return bad verification code error as we do not pass any verification code // docs: https://docs.github.com/en/apps/oauth-apps/maintaining-oauth-apps/troubleshooting-oauth-app-access-token-request-errors#bad-verification-code if err != nil && strings.Contains(err.Error(), githubBadVerificationCodeError) { // mark result as verified only in case of bad verification code error, for any other error the result will be unverified s1.Verified = true } } results = append(results, s1) } } return } func (s Scanner) Type() detectorspb.DetectorType { return detectorspb.DetectorType_GitHubOauth2 } func (s Scanner) Description() string { return "GitHub OAuth2 credentials are used to authenticate and authorize applications to access GitHub's API on behalf of a user or organization. These credentials include a client ID and client secret, which can be used to obtain access tokens for accessing GitHub resources." }