Skip to content

Add rule catalog documentation#59

Merged
stacknil merged 2 commits into
mainfrom
stacknil/loglens-rule-catalog
Jun 14, 2026
Merged

Add rule catalog documentation#59
stacknil merged 2 commits into
mainfrom
stacknil/loglens-rule-catalog

Conversation

@stacknil

Copy link
Copy Markdown
Owner

Summary

  • add docs/rule-catalog.md with fixed per-rule templates
  • document rule name, input event types, grouping key, window, threshold, output subject, false-positive boundary, and why unsupported evidence is not counted
  • clarify that the catalog is Sigma-informed but not a Sigma-compatible export format

Validation

  • verified each rule includes the fixed template labels
  • verified Sigma-informed disclaimer wording
  • ran whitespace check on the new document
  • ran privacy/sensitive-string scan on the new document
  • confirmed PR diff only adds docs/rule-catalog.md

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9c11b88d53

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/rule-catalog.md

This rule identifies concentrated sudo command activity by one user. It does not decide whether the activity is malicious, authorized maintenance, incident response, package management, service repair, or a scripted administrative task.

The finding is strongest when reviewed with session context, change windows, host ownership, and the command text preserved in the report.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove unsupported claim that reports preserve sudo commands

For sudo-burst findings, the report artifacts only render the count/window/summary and do not include the raw Event::message or sudo COMMAND= value in Markdown, JSON, or CSV. In contexts where reviewers follow this catalog and expect the command text to be available in the report, this will misdirect triage unless they return to the original log, so the documentation should not claim that the command text is preserved there.

Useful? React with 👍 / 👎.

@stacknil stacknil merged commit 005c09e into main Jun 14, 2026
7 checks passed
@stacknil stacknil deleted the stacknil/loglens-rule-catalog branch June 14, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant