Skip to content

Update rule setup instructions for UEBA packages - #3652

Merged
jmcarlock merged 4 commits into
mainfrom
update-rule-setup-instructions-for-UEBA-packages
May 28, 2024
Merged

Update rule setup instructions for UEBA packages#3652
jmcarlock merged 4 commits into
mainfrom
update-rule-setup-instructions-for-UEBA-packages

Conversation

@jmcarlock

Copy link
Copy Markdown
Contributor

Issue/Related PR

Summary

The above issue/PR updated the installation instructions for the following packages:

For the detection-rules repo the following changes are requested for each of these packages rules:

  • Point to the new "Installation" section in the UEBA package documentation.
  • Remove any instructions for setting up ingest pipelines and anomaly detectors form this repo as they are duplicated from the integration packages, and less complete here.
  • Remove instructions for custom mappings. These are now handled by each package's fields/custom.yml file.
  • Add the last instruction in a package's installation instructions a user needs to complete to add a specific detection-rule.

Contributor checklist

@jmcarlock jmcarlock added the enhancement New feature or request label May 6, 2024
@jmcarlock jmcarlock self-assigned this May 6, 2024
@susan-shu-c
susan-shu-c requested a review from approksiu May 16, 2024 15:46
@jmcarlock

Copy link
Copy Markdown
Contributor Author

Thank you @approksiu for the review!

@jmcarlock
jmcarlock merged commit 8b28a51 into main May 28, 2024
@jmcarlock
jmcarlock deleted the update-rule-setup-instructions-for-UEBA-packages branch May 28, 2024 19:21
protectionsmachine pushed a commit that referenced this pull request May 28, 2024
* update detection-rules instructions for UEBA packages

---------

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>

Removed changes from:
- rules/integrations/beaconing/command_and_control_beaconing.toml
- rules/integrations/beaconing/command_and_control_beaconing_high_confidence.toml

(selectively cherry picked from commit 8b28a51)
protectionsmachine pushed a commit that referenced this pull request May 28, 2024
* update detection-rules instructions for UEBA packages

---------

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>

Removed changes from:
- rules/integrations/beaconing/command_and_control_beaconing.toml
- rules/integrations/beaconing/command_and_control_beaconing_high_confidence.toml

(selectively cherry picked from commit 8b28a51)
protectionsmachine pushed a commit that referenced this pull request May 28, 2024
* update detection-rules instructions for UEBA packages

---------

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>

(cherry picked from commit 8b28a51)
protectionsmachine pushed a commit that referenced this pull request May 28, 2024
* update detection-rules instructions for UEBA packages

---------

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>

(cherry picked from commit 8b28a51)
protectionsmachine pushed a commit that referenced this pull request May 28, 2024
* update detection-rules instructions for UEBA packages

---------

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>

(cherry picked from commit 8b28a51)
protectionsmachine pushed a commit that referenced this pull request May 28, 2024
* update detection-rules instructions for UEBA packages

---------

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>

(cherry picked from commit 8b28a51)
@terrancedejesus

Copy link
Copy Markdown
Contributor

@jmcarlock - please make sure to update the metadata updated_date for these for future changes. Helps us track changes locally and in BigQuery by date.

Also, note that if you update any rules based on an integration update, the manifest and schemas will need to be updated to reflect this. You can do the following for this to happen.

python -m detection_rules dev integrations build-manifests -o -i beaconing
python -m detection_rules dev integrations build-schemas - beaconing

Thanks buddy!

@jmcarlock

Copy link
Copy Markdown
Contributor Author

Will do. Thank you again @terrancedejesus !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5 participants