Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert Shortcut detector to tri-state verification #2211

Merged
merged 1 commit into from Dec 17, 2023
Merged

Convert Shortcut detector to tri-state verification #2211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 33 additions & 28 deletions pkg/detectors/shortcut/shortcut.go
View file
Open in desktop
Expand Up @@ -2,7 +2,6 @@ package shortcut

import (
"context"
"github.com/go-errors/errors"
"net/http"
"regexp"
"strings"
Expand Down Expand Up @@ -35,7 +34,6 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
dataStr := string(data)

matches := keyPat.FindAllStringSubmatch(dataStr, -1)

for _, match := range matches {
if len(match) != 2 {
continue
Expand All @@ -48,39 +46,46 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
}

if verify {
req, err := http.NewRequestWithContext(ctx, "GET", "https://api.app.shortcut.com/api/v3/member", nil)
if err != nil {
isVerified, verificationErr := verifyResult(ctx, client, resMatch)
s1.Verified = isVerified
s1.SetVerificationError(verificationErr, resMatch)
}

if !s1.Verified {
// 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.
if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) {
continue
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Shortcut-Token", resMatch)
res, err := client.Do(req)
}

if err != nil {
return nil, errors.WrapPrefix(err, "Error making request", 0)
}
results = append(results, s1)
}
return results, nil
}

verifiedBodyResponse, err := common.ResponseContainsSubstring(res.Body, "name")
res.Body.Close()
func verifyResult(ctx context.Context, client *http.Client, apiKey string) (bool, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://api.app.shortcut.com/api/v3/member", nil)
if err != nil {
return false, err
}

if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Shortcut-Token", apiKey)
res, err := client.Do(req)
if err != nil {
return false, err
}

if err == nil {
if res.StatusCode >= 200 && res.StatusCode < 300 && verifiedBodyResponse {
s1.Verified = true
} else {
// 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.
if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) {
continue
}
}
}
}
results = append(results, s1)
verifiedBodyResponse, err := common.ResponseContainsSubstring(res.Body, "name")
_ = res.Body.Close()
if err != nil {
return false, err
}
return results, nil

if res.StatusCode >= 200 && res.StatusCode < 300 && verifiedBodyResponse {
return true, nil
}
return false, nil
}

func (s Scanner) Type() detectorspb.DetectorType {
Expand Down