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

Remove useless sigmahq validator #234

Merged
merged 1 commit into from
Jun 29, 2024
Merged

Remove useless sigmahq validator #234

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 0 additions & 35 deletions sigma/validators/core/metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,6 @@ def finalize(self) -> List[SigmaValidationIssue]:
]


@dataclass
class TitleLengthSigmaHQIssue(SigmaValidationIssue):
description = "Rule has a title longer than 110 characters"
severity = SigmaValidationIssueSeverity.MEDIUM


class TitleLengthSigmaHQValidator(SigmaRuleValidator):
"""Checks if rule has a title length longer than 110."""

def validate(self, rule: SigmaRule) -> List[TitleLengthSigmaHQIssue]:
if len(rule.title) > 110:
return [TitleLengthSigmaHQIssue([rule])]
else:
return []


@dataclass
class DuplicateTitleIssue(SigmaValidationIssue):
description: ClassVar[str] = "Rule title used by multiple rules"
Expand Down Expand Up @@ -208,25 +192,6 @@ def finalize(self) -> List[SigmaValidationIssue]:
]


@dataclass
class FilenameSigmahqIssue(SigmaValidationIssue):
description: ClassVar[str] = "Rule filemane doesn't match SigmaHQ standard"
severity: ClassVar[SigmaValidationIssueSeverity] = SigmaValidationIssueSeverity.HIGH
filename: str


class FilenameSigmahqValidator(SigmaRuleValidator):
"""Check rule filename match SigmaHQ standard."""

def validate(self, rule: SigmaRule) -> List[SigmaValidationIssue]:
filename_pattern = re.compile(r"[a-z0-9_]{10,90}\.yml")
if rule.source is not None:
filename = rule.source.path.name
if filename_pattern.match(filename) is None or not "_" in filename:
return [FilenameSigmahqIssue(rule, filename)]
return []


@dataclass
class FilenameLenghIssue(SigmaValidationIssue):
description: ClassVar[str] = "Rule filename is too short or long"
Expand Down
52 changes: 0 additions & 52 deletions tests/test_validators_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
IdentifierExistenceIssue,
IdentifierUniquenessValidator,
IdentifierCollisionIssue,
TitleLengthSigmaHQIssue,
TitleLengthSigmaHQValidator,
DuplicateTitleIssue,
DuplicateTitleValidator,
DuplicateReferencesIssue,
Expand All @@ -25,8 +23,6 @@
DateExistenceIssue,
DuplicateFilenameValidator,
DuplicateFilenameIssue,
FilenameSigmahqValidator,
FilenameSigmahqIssue,
FilenameLenghValidator,
FilenameLenghIssue,
CustomAttributesValidator,
Expand Down Expand Up @@ -117,40 +113,6 @@ def test_validator_identifier_uniqueness(rules_with_id_collision):
]


def test_validator_lengthy_title():
validator = TitleLengthSigmaHQValidator()
rule = SigmaRule.from_yaml(
"""
title: ThisIsAVeryLongTitleThisIsAVeryLongTitleThisIsAVeryLongTitleThisIsAVeryLongTitleThisIsAVeryLongTitleThisIsAVery
status: test
logsource:
category: test
detection:
sel:
field: path\\*something
condition: sel
"""
)
assert validator.validate(rule) == [TitleLengthSigmaHQIssue([rule])]


def test_validator_lengthy_title_valid():
validator = TitleLengthSigmaHQValidator()
rule = SigmaRule.from_yaml(
"""
title: Test
status: test
logsource:
category: test
detection:
sel:
field: path\\*something
condition: sel
"""
)
assert validator.validate(rule) == []


def test_validator_duplicate_title():
validator = DuplicateTitleValidator()
rule1 = SigmaRule.from_yaml(
Expand Down Expand Up @@ -362,20 +324,6 @@ def test_validator_duplicate_filename_multiple_rules_in_one_file():
assert validator.finalize() == []


def test_validator_sigmahqfilename():
validator = FilenameSigmahqValidator()
sigma_collection = SigmaCollection.load_ruleset(["tests/files/rule_filename_errors"])
rule = sigma_collection[0]
assert validator.validate(rule) == [FilenameSigmahqIssue([rule], "Name.yml")]


def test_validator_sigmahqfilename_valid():
validator = FilenameSigmahqValidator()
sigma_collection = SigmaCollection.load_ruleset(["tests/files/rule_valid"])
rule = sigma_collection[0]
assert validator.validate(rule) == []


def test_validator_filename_lengh():
validator = FilenameLenghValidator()
sigma_collection = SigmaCollection.load_ruleset(["tests/files/rule_filename_errors"])
Expand Down