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

Add " and ' cases for keyword pattern #635

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Add " and ' cases for keyword pattern #635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ba362a7
update action test
babenek Dec 14, 2024
2970ea7
fix keyword pattern with HTML escape quotes
babenek Dec 14, 2024
bfe9c23
MailChimp API Key right border
babenek Dec 16, 2024
15d8791
Merge branch 'main' into fpcase
babenek Dec 16, 2024
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
5 changes: 2 additions & 3 deletions .github/workflows/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,8 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: CredSweeper test
# TODO: change @action to release point with the action
uses: Samsung/CredSweeper@8682ea7d68bf3dfe96e2ea1fad3f04b9b167993b # main
- name: CredSweeper action
uses: Samsung/[email protected] # may be changed to any tag
with:
# args - arguments to credsweeper tool. See default values in action.yml
args: --path ./tests/samples/ --save-json
Expand Down
7 changes: 4 additions & 3 deletions credsweeper/common/keyword_pattern.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class KeywordPattern:
r"(?P<keyword>"
# there will be inserted a keyword
key_right = r")" \
r"[^%:='\"`<>{?!&]*)[`'\"]*)" # <variable>
r"(&(quot|apos);|[^%:='\"`<>{?!&]*)[`'\"]*))" # <variable>
separator = r"(\s|\\+[tnr])*\]?(\s|\\+[tnr])*" \
r"(?P<separator>:( [a-z]{3,9}[?]? )?=|:|=(>|&gt;|\\u0026gt;)|!=|===|==|=|%3d)" \
r"(\s|\\+[tnr])*"
Expand All @@ -21,15 +21,16 @@ class KeywordPattern:
r"([0-9a-z_]{1,32}=)?" \
r")+)?"
string_prefix = r"(((b|r|br|rb|u|f|rf|fr|l|@)(?=(\\*[`'\"])))?"
left_quote = r"(?P<value_leftquote>((?P<esq>\\{1,8})?[`'\"]){1,4}))?"
left_quote = r"(?P<value_leftquote>((?P<esq>\\{1,8})?([`'\"]|&(quot|apos);)){1,4}))?"
# Authentication scheme ( oauth | basic | bearer | apikey ) precedes to credential
auth_keywords = r"( ?(oauth|bot|basic|bearer|apikey|accesskey) )?"
value = r"(?P<value>" \
r"(?(value_leftquote)" \
r"(" \
r"(?!(?P=value_leftquote))" \
r"(?(esq)((?!(?P=esq)['`\"]).)|((?!(?P=value_leftquote)).)))" \
r"(?(esq)((?!(?P=esq)([`'\"]|&(quot|apos);)).)|((?!(?P=value_leftquote)).)))" \
r"|" \
r"(?!&(quot|apos);)" \
r"(\\+([ tnr]|[^\s`'\"])|[^\s`'\",;\\])" \
r"){3,8000}" \
r"|(\{[^}]{3,8000}\})" \
Expand Down
2 changes: 1 addition & 1 deletion credsweeper/rules/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@
confidence: moderate
type: pattern
values:
- (?:(?<![0-9A-Za-z_-])|\\[0abfnrtv]|(%|\\x)[0-9A-Fa-f]{2}|\\[0-7]{3}|\\[Uu]([0-9A-Fa-f]{4}){1,2}|\x1B\[[0-9;]{0,80}m)(?P<value>[0-9A-Za-z_-]{32}-us[0-9]{1,2})
- (?:(?<![0-9A-Za-z_-])|\\[0abfnrtv]|(%|\\x)[0-9A-Fa-f]{2}|\\[0-7]{3}|\\[Uu]([0-9A-Fa-f]{4}){1,2}|\x1B\[[0-9;]{0,80}m)(?P<value>[0-9A-Za-z_-]{32}-us[0-9]{1,2})(?![0-9A-Za-z_-])
filter_type: GeneralPattern
required_substrings:
- -us
Expand Down
6 changes: 3 additions & 3 deletions tests/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
from pathlib import Path

# total number of files in test samples
SAMPLES_FILES_COUNT = 138
SAMPLES_FILES_COUNT = 139

# the lowest value of ML threshold is used to display possible lowest values
NEGLIGIBLE_ML_THRESHOLD = 0.0001

# credentials count after scan with negligible ML threshold
SAMPLES_CRED_COUNT = 425
SAMPLES_CRED_COUNT = 428
SAMPLES_CRED_LINE_COUNT = SAMPLES_CRED_COUNT + 19

# Number of filtered credentials with ML
Expand All @@ -17,7 +17,7 @@
SAMPLES_POST_CRED_COUNT = SAMPLES_CRED_COUNT - ML_FILTERED

# with option --doc
SAMPLES_IN_DOC = 468
SAMPLES_IN_DOC = 470

# archived credentials that are not found without --depth
SAMPLES_IN_DEEP_1 = SAMPLES_POST_CRED_COUNT + 33
Expand Down
78 changes: 78 additions & 0 deletions tests/data/depth_3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10687,6 +10687,84 @@
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.96,
"rule": "Token",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": "<a href=\"http://example.com?token=&quot;g1re0g1T0keN3zWx&quot;\">TokenRequest</a>",
"line_num": 9,
"path": "./tests/samples/sample.html",
"info": "./tests/samples/sample.html|RAW",
"value": "g1re0g1T0keN3zWx",
"value_start": 40,
"value_end": 56,
"variable": "token",
"variable_start": 28,
"variable_end": 33,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.5,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.999,
"rule": "Password",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": " placeholder=\"Your password: &quot;g1re0g1Pa5$w0Rd&quot;\"",
"line_num": 16,
"path": "./tests/samples/sample.html",
"info": "./tests/samples/sample.html|RAW",
"value": "g1re0g1Pa5$w0Rd",
"value_start": 38,
"value_end": 53,
"variable": "Your password",
"variable_start": 17,
"variable_end": 30,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.246431222567951,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.998,
"rule": "Password",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": " <button onclick=\"alert(&quot;password:g1re0g2Pa5$w0Rd&quot;)\">ShowPass</button>",
"line_num": 21,
"path": "./tests/samples/sample.html",
"info": "./tests/samples/sample.html|RAW",
"value": "g1re0g2Pa5$w0Rd",
"value_start": 39,
"value_end": 54,
"variable": "password",
"variable_start": 30,
"variable_end": 38,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.379764555901284,
"valid": false
}
}
]
},
{
"ml_validation": "NOT_AVAILABLE",
"ml_probability": null,
Expand Down
52 changes: 52 additions & 0 deletions tests/data/doc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12874,6 +12874,58 @@
}
]
},
{
"ml_validation": "NOT_AVAILABLE",
"ml_probability": null,
"rule": "PASSWD_PAIR",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": "placeholder=\"Your password: &quot;g1re0g1Pa5$w0Rd&quot;\"",
"line_num": 16,
"path": "./tests/samples/sample.html",
"info": "./tests/samples/sample.html|RAW",
"value": "&quot;g1re0g1Pa5$w0Rd&quot;\"",
"value_start": 32,
"value_end": 60,
"variable": "password",
"variable_start": 22,
"variable_end": 30,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.2772074387595462,
"valid": false
}
}
]
},
{
"ml_validation": "NOT_AVAILABLE",
"ml_probability": null,
"rule": "PASSWD_PAIR",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": "<button onclick=\"alert(&quot;password:g1re0g2Pa5$w0Rd&quot;)\">ShowPass</button>",
"line_num": 21,
"path": "./tests/samples/sample.html",
"info": "./tests/samples/sample.html|RAW",
"value": "g1re0g2Pa5$w0Rd&quot;",
"value_start": 39,
"value_end": 60,
"variable": "password",
"variable_start": 30,
"variable_end": 38,
"entropy_validation": {
"iterator": "BASE36_CHARS",
"entropy": 3.1560513697361983,
"valid": true
}
}
]
},
{
"ml_validation": "NOT_AVAILABLE",
"ml_probability": null,
Expand Down
78 changes: 78 additions & 0 deletions tests/data/ml_threshold.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10280,6 +10280,84 @@
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.96,
"rule": "Token",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": "<a href=\"http://example.com?token=&quot;g1re0g1T0keN3zWx&quot;\">TokenRequest</a>",
"line_num": 9,
"path": "./tests/samples/sample.html",
"info": "",
"value": "g1re0g1T0keN3zWx",
"value_start": 40,
"value_end": 56,
"variable": "token",
"variable_start": 28,
"variable_end": 33,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.5,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.999,
"rule": "Password",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": " placeholder=\"Your password: &quot;g1re0g1Pa5$w0Rd&quot;\"",
"line_num": 16,
"path": "./tests/samples/sample.html",
"info": "",
"value": "g1re0g1Pa5$w0Rd",
"value_start": 38,
"value_end": 53,
"variable": "Your password",
"variable_start": 17,
"variable_end": 30,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.246431222567951,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.998,
"rule": "Password",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": " <button onclick=\"alert(&quot;password:g1re0g2Pa5$w0Rd&quot;)\">ShowPass</button>",
"line_num": 21,
"path": "./tests/samples/sample.html",
"info": "",
"value": "g1re0g2Pa5$w0Rd",
"value_start": 39,
"value_end": 54,
"variable": "password",
"variable_start": 30,
"variable_end": 38,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.379764555901284,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.672,
Expand Down
78 changes: 78 additions & 0 deletions tests/data/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9188,6 +9188,84 @@
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.96,
"rule": "Token",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": "<a href=\"http://example.com?token=&quot;g1re0g1T0keN3zWx&quot;\">TokenRequest</a>",
"line_num": 9,
"path": "./tests/samples/sample.html",
"info": "",
"value": "g1re0g1T0keN3zWx",
"value_start": 40,
"value_end": 56,
"variable": "token",
"variable_start": 28,
"variable_end": 33,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.5,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.999,
"rule": "Password",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": " placeholder=\"Your password: &quot;g1re0g1Pa5$w0Rd&quot;\"",
"line_num": 16,
"path": "./tests/samples/sample.html",
"info": "",
"value": "g1re0g1Pa5$w0Rd",
"value_start": 38,
"value_end": 53,
"variable": "Your password",
"variable_start": 17,
"variable_end": 30,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.246431222567951,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.998,
"rule": "Password",
"severity": "medium",
"confidence": "moderate",
"line_data_list": [
{
"line": " <button onclick=\"alert(&quot;password:g1re0g2Pa5$w0Rd&quot;)\">ShowPass</button>",
"line_num": 21,
"path": "./tests/samples/sample.html",
"info": "",
"value": "g1re0g2Pa5$w0Rd",
"value_start": 39,
"value_end": 54,
"variable": "password",
"variable_start": 30,
"variable_end": 38,
"entropy_validation": {
"iterator": "BASE64_CHARS",
"entropy": 3.379764555901284,
"valid": false
}
}
]
},
{
"ml_validation": "VALIDATED_KEY",
"ml_probability": 0.672,
Expand Down
Loading
Loading