Skip to content

The cross-harness, self-improving memory layer for AI agents. Join our community: https://discord.com/invite/zdNChS2fBu

Ship the threat-rule pack as a release asset, not in the binary

Justin D'Souza930bedc2a2ce
diff --git a/.gitignore b/.gitignore
index 04be3512..e80257dd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -24,6 +24,7 @@ coverage.html
cli/beacon/beacon
cli/beacon/beacon-*
cli/beacon/dist/
+cli/beacon/release-rules/
dist/
# Hook helper binaries
diff --git a/README.md b/README.md
index d12733af..885e3e40 100644
--- a/README.md
+++ b/README.md
@@ -225,8 +225,17 @@ beacon rules lint ./rules # validate + run a rule pack's fixtures (autho
beacon rules fields # list event fields a rule can match on
```
+The full rule pack ships as a release asset (`threat-rules.tar.gz`), not inside the
+binary, so the corpus grows without enlarging `beacon`. Install it with one command:
+
+```bash
+beacon rules pull https://github.com/asymptote-labs/agent-beacon/releases/latest/download/threat-rules.tar.gz
+beacon scan
+```
+
`beacon rules pull` is the only command that reaches the network, and only when you run
-it against a URL you supply — the agent never fetches rules on its own.
+it against a URL you supply — the agent never fetches rules on its own. Offline or
+air-gapped users can instead `git clone` the repo and run `beacon rules add ./rules`.
## Start Here
diff --git a/cli/beacon/.goreleaser.yaml b/cli/beacon/.goreleaser.yaml
index c12075bf..8bb0afd5 100644
--- a/cli/beacon/.goreleaser.yaml
+++ b/cli/beacon/.goreleaser.yaml
@@ -13,6 +13,9 @@ before:
- cp ../../collector-builder/dist/beacon-otelcol/darwin_arm64/beacon-otelcol ./release-collectors/darwin_arm64/beacon-otelcol
- cp ../../collector-builder/dist/beacon-otelcol/linux_amd64/beacon-otelcol ./release-collectors/linux_amd64/beacon-otelcol
- cp ../../collector-builder/dist/beacon-otelcol/linux_arm64/beacon-otelcol ./release-collectors/linux_arm64/beacon-otelcol
+ # Package the external threat-rule pack (repo rules/, not embedded in the binary)
+ # as a release asset users install with `beacon rules pull <asset-url>`.
+ - bash -c 'mkdir -p release-rules && tar -czf release-rules/threat-rules.tar.gz -C ../.. rules'
builds:
- id: beacon
@@ -127,6 +130,10 @@ release:
draft: false
prerelease: auto
name_template: "v{{.Version}}"
+ extra_files:
+ # The threat-rule pack ships as a separate asset, not embedded in the binary,
+ # so the rule corpus can grow without enlarging `beacon`.
+ - glob: ./release-rules/threat-rules.tar.gz
footer: |
## Installation
@@ -145,3 +152,12 @@ release:
beacon endpoint status
beacon endpoint wazuh print-config
```
+
+ ## Threat detection rules
+ `beacon` ships with a small built-in baseline. Install the full threat-rule
+ pack (attached as `threat-rules.tar.gz` below) and scan your local telemetry:
+ ```bash
+ beacon rules pull https://github.com/asymptote-labs/agent-beacon/releases/download/v{{.Version}}/threat-rules.tar.gz
+ beacon rules list
+ beacon scan
+ ```
diff --git a/cli/beacon/Makefile b/cli/beacon/Makefile
index 378be77a..59c519c6 100644
--- a/cli/beacon/Makefile
+++ b/cli/beacon/Makefile
@@ -123,3 +123,11 @@ lint:
# Run go mod tidy
tidy:
go mod tidy
+
+# Package the external threat-rule pack (repo rules/, not embedded in the binary)
+# into a tarball that `beacon rules pull` / `beacon rules add` can install. The
+# release build produces the same artifact via the goreleaser before-hook.
+rules-pack:
+ mkdir -p release-rules
+ tar -czf release-rules/threat-rules.tar.gz -C ../.. rules
+ @echo "wrote release-rules/threat-rules.tar.gz"