Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fixes/work based on testing * Remove some commented code * Change how verification happens and grab additional information * Address linter warnings. * add shopify detector to default detectors. Co-authored-by: Dustin Decker <dustin@trufflesec.com> Co-authored-by: Ahrav Dutta <ahravdutta02@gmail.com>
- Loading branch information
1 parent
02ed33d
commit ecd2578
Showing
5 changed files
with
235 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
package shopify | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"net/http" | ||
"regexp" | ||
"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() | ||
|
||
// Make sure that your group is surrounded in boundry characters such as below to reduce false positives. | ||
keyPat = regexp.MustCompile(`\b(shppa_|shpat_)([0-9A-Fa-f]{32})\b`) | ||
domainPat = regexp.MustCompile(`[a-zA-Z0-9-]+\.myshopify\.com`) | ||
) | ||
|
||
// 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{"shppa_", "shpat_"} | ||
} | ||
|
||
// FromData will find and optionally verify Shopify 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) | ||
|
||
keyMatches := keyPat.FindAllString(dataStr, -1) | ||
domainMatches := domainPat.FindAllString(dataStr, -1) | ||
|
||
for _, match := range keyMatches { | ||
key := strings.TrimSpace(match) | ||
|
||
for _, domainMatch := range domainMatches { | ||
domainRes := strings.TrimSpace(domainMatch) | ||
|
||
s1 := detectors.Result{ | ||
DetectorType: detectorspb.DetectorType_Shopify, | ||
Redacted: domainRes, | ||
Raw: []byte(key + domainRes), | ||
} | ||
|
||
if verify { | ||
req, err := http.NewRequestWithContext(ctx, "GET", "https://"+domainRes+"/admin/oauth/access_scopes.json", nil) | ||
if err != nil { | ||
continue | ||
} | ||
req.Header.Add("X-Shopify-Access-Token", key) | ||
res, err := client.Do(req) | ||
if err == nil { | ||
if res.StatusCode >= 200 && res.StatusCode < 300 { | ||
shopifyTokenAccessScopes := shopifyTokenAccessScopes{} | ||
err := json.NewDecoder(res.Body).Decode(&shopifyTokenAccessScopes) | ||
if err == nil { | ||
var handleArray []string | ||
for _, handle := range shopifyTokenAccessScopes.AccessScopes { | ||
handleArray = append(handleArray, handle.Handle) | ||
|
||
} | ||
s1.Verified = true | ||
s1.ExtraData = map[string]string{ | ||
"access_scopes": strings.Join(handleArray, ","), | ||
} | ||
} | ||
res.Body.Close() | ||
} | ||
} 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(key, detectors.DefaultFalsePositives, true) { | ||
continue | ||
} | ||
} | ||
} | ||
|
||
results = append(results, s1) | ||
|
||
} | ||
|
||
} | ||
|
||
return results, nil | ||
|
||
} | ||
|
||
type shopifyTokenAccessScopes struct { | ||
AccessScopes []struct { | ||
Handle string `json:"handle"` | ||
} `json:"access_scopes"` | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
package shopify | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"testing" | ||
"time" | ||
|
||
"github.com/kylelemons/godebug/pretty" | ||
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors" | ||
|
||
"github.com/trufflesecurity/trufflehog/v3/pkg/common" | ||
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" | ||
) | ||
|
||
func TestShopify_FromChunk(t *testing.T) { | ||
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) | ||
defer cancel() | ||
testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors4") | ||
if err != nil { | ||
t.Fatalf("could not get test secrets from GCP: %s", err) | ||
} | ||
secret := testSecrets.MustGetField("SHOPIFY_ADMIN_SECRET") | ||
inactiveSecret := testSecrets.MustGetField("SHOPIFY_ADMIN_SECRET_INACTIVE") | ||
domain := testSecrets.MustGetField("SHOPIFY_DOMAIN") | ||
|
||
type args struct { | ||
ctx context.Context | ||
data []byte | ||
verify bool | ||
} | ||
tests := []struct { | ||
name string | ||
s Scanner | ||
args args | ||
want []detectors.Result | ||
wantErr bool | ||
}{ | ||
{ | ||
name: "found, verified", | ||
s: Scanner{}, | ||
args: args{ | ||
ctx: context.Background(), | ||
data: []byte(fmt.Sprintf("You can find a shopify secret %s domain https://%s", secret, domain)), | ||
verify: true, | ||
}, | ||
want: []detectors.Result{ | ||
{ | ||
DetectorType: detectorspb.DetectorType_Shopify, | ||
Redacted: domain, | ||
Verified: true, | ||
ExtraData: map[string]string{ | ||
"access_scopes": "read_analytics,unauthenticated_read_selling_plans", | ||
}, | ||
}, | ||
}, | ||
wantErr: false, | ||
}, | ||
{ | ||
name: "found, unverified", | ||
s: Scanner{}, | ||
args: args{ | ||
ctx: context.Background(), | ||
data: []byte(fmt.Sprintf("You can find a shopify secret %s within (domain https://%s) but not valid", inactiveSecret, domain)), // the secret would satisfy the regex but not pass validation | ||
verify: true, | ||
}, | ||
want: []detectors.Result{ | ||
{ | ||
DetectorType: detectorspb.DetectorType_Shopify, | ||
Redacted: domain, | ||
Verified: false, | ||
ExtraData: nil, | ||
}, | ||
}, | ||
wantErr: false, | ||
}, | ||
{ | ||
name: "not found", | ||
s: Scanner{}, | ||
args: args{ | ||
ctx: context.Background(), | ||
data: []byte("You cannot find the secret within"), | ||
verify: true, | ||
}, | ||
want: nil, | ||
wantErr: false, | ||
}, | ||
} | ||
for _, tt := range tests { | ||
t.Run(tt.name, func(t *testing.T) { | ||
s := Scanner{} | ||
got, err := s.FromData(tt.args.ctx, tt.args.verify, tt.args.data) | ||
if (err != nil) != tt.wantErr { | ||
t.Errorf("Shopify.FromData() error = %v, wantErr %v", err, tt.wantErr) | ||
return | ||
} | ||
for i := range got { | ||
if len(got[i].Raw) == 0 { | ||
t.Fatalf("no raw secret present: \n %+v", got[i]) | ||
} | ||
got[i].Raw = nil | ||
} | ||
if diff := pretty.Compare(got, tt.want); diff != "" { | ||
t.Errorf("Shopify.FromData() %s diff: (-got +want)\n%s", tt.name, diff) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func BenchmarkFromData(benchmark *testing.B) { | ||
ctx := context.Background() | ||
s := Scanner{} | ||
for name, data := range detectors.MustGetBenchmarkData() { | ||
benchmark.Run(name, func(b *testing.B) { | ||
for n := 0; n < b.N; n++ { | ||
_, err := s.FromData(ctx, false, data) | ||
if err != nil { | ||
b.Fatal(err) | ||
} | ||
} | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -908,6 +908,7 @@ enum DetectorType { | |
SQLServer = 898; | ||
FTP = 899; | ||
Redis = 900; | ||
Shopify = 902; | ||
} | ||
|
||
message Result { | ||
|