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

fixed jirav1 detector email pattern #3826

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fixed jirav1 detector email pattern #3826

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a57b59
fixed jirav1 detector email pattern
kashifkhan0771 Dec 31, 2024
c0d2449
Merge branch 'main' into fix/github-issue-3818
kashifkhan0771 Dec 31, 2024
2857ebf
Merge branch 'main' into fix/github-issue-3818
kashifkhan0771 Jan 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 21 additions & 24 deletions pkg/detectors/jiratoken/v1/jiratoken.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

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"
)
Expand All @@ -30,7 +31,7 @@ var (
// Make sure that your group is surrounded in boundary characters such as below to reduce false positives.
tokenPat = regexp.MustCompile(detectors.PrefixRegex([]string{"jira"}) + `\b([a-zA-Z-0-9]{24})\b`)
domainPat = regexp.MustCompile(detectors.PrefixRegex([]string{"jira"}) + `\b([a-zA-Z-0-9]{5,24}\.[a-zA-Z-0-9]{3,16}\.[a-zA-Z-0-9]{3,16})\b`)
emailPat = regexp.MustCompile(detectors.PrefixRegex([]string{"jira"}) + `\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b`)
emailPat = regexp.MustCompile(detectors.PrefixRegex([]string{"jira"}) + common.EmailPattern)
)

const (
Expand All @@ -48,31 +49,27 @@ func (s Scanner) Keywords() []string {
func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) {
dataStr := string(data)

tokens := tokenPat.FindAllStringSubmatch(dataStr, -1)
domains := domainPat.FindAllStringSubmatch(dataStr, -1)
emails := emailPat.FindAllStringSubmatch(dataStr, -1)
var uniqueTokens, uniqueDomains, uniqueEmails = make(map[string]struct{}), make(map[string]struct{}), make(map[string]struct{})

for _, email := range emails {
email = strings.Split(email[0], " ")
if len(email) != 2 {
continue
}
resEmail := strings.TrimSpace(email[1])
for _, token := range tokens {
if len(token) != 2 {
continue
}
resToken := strings.TrimSpace(token[1])
for _, domain := range domains {
if len(domain) != 2 {
continue
}
resDomain := strings.TrimSpace(domain[1])
for _, token := range tokenPat.FindAllStringSubmatch(dataStr, -1) {
uniqueTokens[token[1]] = struct{}{}
}

for _, domain := range domainPat.FindAllStringSubmatch(dataStr, -1) {
uniqueDomains[domain[1]] = struct{}{}
}

for _, email := range emailPat.FindAllStringSubmatch(dataStr, -1) {
uniqueEmails[strings.ToLower(email[1])] = struct{}{}
}

for email := range uniqueEmails {
for token := range uniqueTokens {
for domain := range uniqueDomains {
s1 := detectors.Result{
DetectorType: detectorspb.DetectorType_JiraToken,
Raw: []byte(resToken),
RawV2: []byte(fmt.Sprintf("%s:%s:%s", resEmail, resToken, resDomain)),
Raw: []byte(token),
RawV2: []byte(fmt.Sprintf("%s:%s:%s", email, token, domain)),
ExtraData: map[string]string{
"rotation_guide": "https://howtorotate.com/docs/tutorials/atlassian/",
"version": fmt.Sprintf("%d", s.Version()),
Expand All @@ -81,9 +78,9 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result

if verify {
client := s.getClient()
isVerified, verificationErr := verifyJiratoken(ctx, client, resEmail, resDomain, resToken)
isVerified, verificationErr := verifyJiratoken(ctx, client, email, domain, token)
s1.Verified = isVerified
s1.SetVerificationError(verificationErr, resToken)
s1.SetVerificationError(verificationErr, token)
}

results = append(results, s1)
Expand Down
2 changes: 1 addition & 1 deletion pkg/detectors/jiratoken/v1/jiratoken_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ var (
invalidTokenPattern = "Z7VoI?J0K4rF#LBfkhO&LAWX"
validDomainPattern = "hereisavalidsubdomain.heresalongdomain.com"
invalidDomainPattern = "?y4r3fs1ewqec12v1e3tl.5Hcsrcehic89saXd.ro@"
validEmailPattern = "xfKF_BZq7@grum.com"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kashifkhan0771 Not sure but the old input is also valid email and should pass the user case.

Copy link
Contributor Author

@kashifkhan0771 kashifkhan0771 Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our common email pattern is not configured to capture capital letters. I guess we need a small enhancement in the common email pattern. Including flag (?i) in start will work.
Thoughts @abmussani @zricethezav @ahrav ?

validEmailPattern = "xfkf_bz7@grum.com"
invalidEmailPattern = "xfKF_BZq7/grum.com"
keyword = "jira"
)
Expand Down
Loading