Skip to content

docs: list Watch Rule operators and clarify no regex support#236

Merged
maximelb merged 1 commit into
masterfrom
docs/exfil-watch-rule-operators
May 21, 2026
Merged

docs: list Watch Rule operators and clarify no regex support#236
maximelb merged 1 commit into
masterfrom
docs/exfil-watch-rule-operators

Conversation

@maximelb
Copy link
Copy Markdown
Contributor

Summary

  • A customer in #help tried to use operator: matches with a regex value. The Exfil docs describe the four Watch Rule fields (event/path/operator/value) but never list which operators actually exist or how the value is matched, so the misuse was easy to land in.
  • The sensor (sensor/modules/hbs/exfil_engine.c) and the cloud extension (ext-exfil/ext/defaults.go ExfilWatchOperators) agree on exactly four operators: is, contains, starts with, ends with. All four do literal, case-insensitive string matching — values are lowercased on both sides before comparison and there is no regex/glob engine anywhere. An unknown operator string maps to 0 server-side, which the sensor's exfilEngine_new switch treats as invalid and drops the rule entirely.
  • This PR adds a Watch Rule Operators subsection under ## Using the Exfil Extension with the operator table and a short list of the surprising behaviors (no regex, case-insensitive, string-only fields, unknown operators silently dropped).

Test plan

  • npx --yes markdownlint-cli2 "docs/5-integrations/extensions/limacharlie/exfil.md" — 0 errors

🤖 Generated with Claude Code

Customers were assuming `operator: matches` works as a regex; only
`is` / `contains` / `starts with` / `ends with` are supported, the
comparison is literal and case-insensitive, and unknown operators are
silently dropped on the sensor.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@maximelb maximelb requested a review from steveatlc May 21, 2026 15:38
@maximelb maximelb added the to-code-review Used to tag PRs that are force-pushed and will need to be reviewed after the fact. label May 21, 2026
@maximelb maximelb marked this pull request as ready for review May 21, 2026 15:38
@maximelb maximelb merged commit 422b6ef into master May 21, 2026
2 checks passed
@maximelb maximelb deleted the docs/exfil-watch-rule-operators branch May 21, 2026 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

to-code-review Used to tag PRs that are force-pushed and will need to be reviewed after the fact.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant