Skip to content

Commit

Permalink
feat(hubspot): unify v1 and v2 implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Gomez committed Jun 18, 2024
1 parent c719d04 commit 1b4ca8a
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 92 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package hubspotapikey
package v1

import (
"context"
Expand All @@ -17,11 +17,13 @@ type Scanner struct {
client *http.Client
}

func (s Scanner) Version() int { return 1 }

// Ensure the Scanner satisfies the interface at compile time.
var _ detectors.Detector = (*Scanner)(nil)
var _ detectors.Versioner = (*Scanner)(nil)
var _ interface {
detectors.Detector
detectors.Versioner
} = (*Scanner)(nil)

func (s Scanner) Version() int { return 1 }

var (
defaultClient = common.SaneHttpClient()
Expand All @@ -32,7 +34,7 @@ var (
// 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{"hubspot", "hubapi", "hapikey", "hapi_key"}
return []string{"hubapi", "hapikey", "hapi_key", "hubspot"}
}

// FromData will find and optionally verify HubSpotApiKey secrets in a given set of bytes.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//go:build detectors
// +build detectors

package hubspotapikey
package v1

import (
"context"
Expand All @@ -10,6 +10,7 @@ import (
"time"

"github.com/kylelemons/godebug/pretty"

"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"

"github.com/trufflesecurity/trufflehog/v3/pkg/common"
Expand Down
104 changes: 104 additions & 0 deletions pkg/detectors/hubspot_apikey/v2/hubspot_apikey_v2.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
package v2

import (
"context"
"io"

// "log"
"fmt"
"net/http"

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/detectorspb"
)

type Scanner struct {
client *http.Client
}

func (s Scanner) Version() int { return 2 }

// Ensure the Scanner satisfies the interface at compile time.
var _ interface {
detectors.Detector
detectors.Versioner
} = (*Scanner)(nil)

var (
defaultClient = common.SaneHttpClient()

keyPat = regexp.MustCompile(`\b(pat-(?:eu|na1)-[A-Za-z0-9]{8}\-[A-Za-z0-9]{4}\-[A-Za-z0-9]{4}\-[A-Za-z0-9]{4}\-[A-Za-z0-9]{12})\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{"pat-na1-", "pat-eu1-"}
}

// FromData will find and optionally verify HubSpotApiKey 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)

uniqueMatches := make(map[string]struct{})
for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) {
uniqueMatches[match[1]] = struct{}{}
}

for token := range uniqueMatches {
s1 := detectors.Result{
DetectorType: detectorspb.DetectorType_HubSpotApiKey,
Raw: []byte(token),
Redacted: token[8:] + "...",
}

if verify {
client := s.client
if client == nil {
client = defaultClient
}

verified, verificationErr := verifyToken(ctx, client, token)
s1.Verified = verified
s1.SetVerificationError(verificationErr)
}

results = append(results, s1)
}

return results, nil
}
func verifyToken(ctx context.Context, client *http.Client, token string) (bool, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://api.hubapi.com/account-info/v3/api-usage/daily/private-apps", nil)
if err != nil {
return false, err
}
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", token))
res, err := client.Do(req)
if err != nil {
return false, err
}
defer func() {
_, _ = io.Copy(io.Discard, res.Body)
_ = res.Body.Close()
}()

switch res.StatusCode {
case http.StatusOK:
return true, nil
case http.StatusUnauthorized:
return false, nil
case http.StatusForbidden:
// The token is valid but lacks permission for the endpoint.
return true, nil
default:
return false, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
}
}

func (s Scanner) Type() detectorspb.DetectorType {
return detectorspb.DetectorType_HubSpotApiKey
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//go:build detectors
// +build detectors

package hubspotapikeyv2
package v2

import (
"context"
Expand All @@ -10,6 +10,7 @@ import (
"time"

"github.com/kylelemons/godebug/pretty"

"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"

"github.com/trufflesecurity/trufflehog/v3/pkg/common"
Expand Down
79 changes: 0 additions & 79 deletions pkg/detectors/hubspotapikeyv2/hubspotapikeyv2.go

This file was deleted.

9 changes: 4 additions & 5 deletions pkg/engine/defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,8 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/honeycomb"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/host"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/html2pdf"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/hubspotapikey"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/hubspotapikeyv2"
hubspot_apikey_v1 "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/hubspot_apikey/v1"
hubspot_apikey_v2 "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/hubspot_apikey/v2"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/huggingface"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/humanity"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/hunter"
Expand Down Expand Up @@ -852,7 +852,7 @@ func DefaultDetectors() []detectors.Detector {
&rapidapi.Scanner{},
&discordbottoken.Scanner{},
&netlify.Scanner{},
&hubspotapikey.Scanner{},
&hubspot_apikey_v1.Scanner{},
&travisci.Scanner{},
&scalewaykey.Scanner{},
&fastlypersonaltoken.Scanner{},
Expand Down Expand Up @@ -1611,8 +1611,7 @@ func DefaultDetectors() []detectors.Detector {
groq.Scanner{},
twitterconsumerkey.Scanner{},
eraser.Scanner{},
jiratoken_v2.Scanner{},
hubspotapikeyv2.Scanner{},
&hubspot_apikey_v2.Scanner{},
}
}

Expand Down

0 comments on commit 1b4ca8a

Please sign in to comment.