Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
feat(huggingface): enhance extradata (#2222)
Richard Gomezded8e459bd0a
diff --git a/pkg/detectors/huggingface/huggingface.go b/pkg/detectors/huggingface/huggingface.goindex 1d463e6f5..725c3678c 100644--- a/pkg/detectors/huggingface/huggingface.go+++ b/pkg/detectors/huggingface/huggingface.go@@ -2,6 +2,7 @@ package huggingfaceimport ("context"+ "encoding/json""fmt""net/http""regexp"@@ -49,31 +50,10 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result}if verify {- client := s.client- if client == nil {- client = defaultClient- }- req, err := http.NewRequestWithContext(ctx, "GET", "https://huggingface.co/api/whoami-v2", nil)- if err != nil {- continue- }-- req.Header.Set("Authorization", "Bearer "+resMatch)-- res, err := client.Do(req)- if err == nil {- defer res.Body.Close()- if res.StatusCode >= 200 && res.StatusCode < 300 {- s1.Verified = true- } else if res.StatusCode == 401 {- // The secret is determinately not verified (nothing to do)- } else {- err = fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)- s1.SetVerificationError(err, resMatch)- }- } else {- s1.SetVerificationError(err, resMatch)- }+ isVerified, extraData, verificationErr := s.verifyResult(ctx, resMatch)+ s1.Verified = isVerified+ s1.ExtraData = extraData+ s1.SetVerificationError(verificationErr, resMatch)}// 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.@@ -87,6 +67,76 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (resultreturn results, nil}+func (s Scanner) verifyResult(ctx context.Context, apiKey string) (bool, map[string]string, error) {+ client := s.client+ if client == nil {+ client = defaultClient+ }++ req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://huggingface.co/api/whoami-v2", nil)+ if err != nil {+ return false, nil, nil+ }++ req.Header.Set("Authorization", "Bearer "+apiKey)+ res, err := client.Do(req)+ if err != nil {+ return false, nil, err+ }++ defer res.Body.Close()+ if res.StatusCode >= 200 && res.StatusCode < 300 {+ whoamiRes := whoamiResponse{}+ err := json.NewDecoder(res.Body).Decode(&whoamiRes)+ if err != nil {+ return true, nil, err+ }++ t := whoamiRes.Auth.AccessToken+ extraData := map[string]string{+ "Username": whoamiRes.Name,+ "Email": whoamiRes.Email,+ "Token": fmt.Sprintf("%s (%s)", t.DisplayName, t.Role),+ }++ // Condense a list of organizations + roles.+ var orgs []string+ for _, org := range whoamiRes.Organizations {+ orgs = append(orgs, fmt.Sprintf("%s:%s", org.Name, org.Role))+ }+ if len(orgs) > 0 {+ extraData["Organizations"] = strings.Join(orgs, ", ")+ }+ return true, extraData, nil+ } else if res.StatusCode == 401 {+ // The secret is determinately not verified (nothing to do)+ return false, nil, nil+ } else {+ err = fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)+ return false, nil, err+ }+}+func (s Scanner) Type() detectorspb.DetectorType {return detectorspb.DetectorType_HuggingFace}++// https://huggingface.co/docs/hub/api#get-apiwhoami-v2+type whoamiResponse struct {+ Name string `json:"name"`+ Email string `json:"email"`+ Organizations []organization `json:"orgs"`+ Auth auth `json:"auth"`+}++type organization struct {+ Name string `json:"name"`+ Role string `json:"roleInOrg"`+}++type auth struct {+ AccessToken struct {+ DisplayName string `json:"displayName"`+ Role string `json:"role"`+ } `json:"accessToken"`+}