Building 70 Projects ranging from beginner to advanced so anyone can — learn from, build upon, use as a reference, or even copy directly. Owned by my cybersecurity company 👇
Go aicertificationcloud-engineeringcybercybersecuritycybersecurity-analystcybersecurity-certificationcybersecurity-certificationscybersecurity-educationcybersecurity-jobscybersecurity-portfoliocybersecurity-projectscybersecurity-toolsgrchackinglearningpentestingproject-repositoryprojetcspython
"""
©AngelaMos | 2026
CorrelationRule.py
MongoEngine model for correlation detection rules
Stores rule definitions including type, conditions dict, severity,
MITRE mappings, and enabled flag. get_enabled_rules is called by
the correlation engine on a TTL-cached basis to avoid per-event
database queries.
Key exports:
CorrelationRule - rule document with get_enabled_rules class method
RuleType - StrEnum of supported evaluation strategies
Connects to:
models/Base.py - extends BaseDocument
models/LogEvent.py - imports Severity for field choices
engine/correlation.py - calls get_enabled_rules, uses RuleType
controllers/rule_ctrl.py - CRUD and test operations
schemas/rule.py - imports RuleType
"""
from typing import Any
from enum import StrEnum
from mongoengine import (
StringField,
DictField,
BooleanField,
)
from app.models.Base import BaseDocument
from app.models.LogEvent import Severity
class RuleType(StrEnum):
"""
Supported correlation rule evaluation strategies
"""
THRESHOLD = "threshold"
SEQUENCE = "sequence"
AGGREGATION = "aggregation"
class CorrelationRule(BaseDocument):
"""
Correlation rule with conditions and evaluation metadata
"""
meta: dict[str, Any] = { # noqa: RUF012
"collection": "correlation_rules",
"ordering": ["-created_at"],
"indexes": ["enabled", "rule_type"],
}
name = StringField(required=True, unique=True)
description = StringField(default="")
rule_type = StringField(
required=True,
choices=[t.value for t in RuleType],
)
conditions = DictField(required=True)
severity = StringField(
required=True,
choices=[s.value for s in Severity],
)
enabled = BooleanField(default=True)
mitre_tactic = StringField()
mitre_technique = StringField()
@classmethod
def get_enabled_rules(cls) -> list[Any]:
"""
Return all rules that are currently enabled
"""
return list(cls.objects(enabled=True)) # type: ignore[no-untyped-call]