Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace master doc URLs with current #4439

Merged
merged 5 commits into from
Feb 3, 2025
Merged

Replace master doc URLs with current #4439

merged 5 commits into from
Feb 3, 2025

Conversation

shashank-elastic
Copy link
Contributor

@shashank-elastic shashank-elastic commented Feb 3, 2025 •
edited
Loading

Pull Request

Issue link(s): Creating a PR for the document fix from reference PR - #4433

Summary - What I changed

How To Test

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, maintenance, Rule: New, Rule: Deprecation, Rule: Tuning, Hunt: New, or Hunt: Tuning so guidelines can be generated
  • Added the meta:rapid-merge label if planning to merge within 24 hours
  • Secret and sensitive material has been managed correctly
  • Automated testing was updated or added to match the most common scenarios
  • Documentation and comments were added for features that require explanation

Contributor checklist

@shashank-elastic shashank-elastic added Rule: Tuning tweaking or tuning an existing rule meta:rapid-merge labels Feb 3, 2025
@shashank-elastic shashank-elastic self-assigned this Feb 3, 2025
@shashank-elastic shashank-elastic marked this pull request as ready for review February 3, 2025 14:31
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 3, 2025

Rule: Tuning - Guidelines

These guidelines serve as a reminder set of considerations when tuning an existing rule.

Documentation and Context

  • Detailed description of the suggested changes.
  • Provide example JSON data or screenshots.
  • Provide evidence of reducing benign events mistakenly identified as threats (False Positives).
  • Provide evidence of enhancing detection of true threats that were previously missed (False Negatives).
  • Provide evidence of optimizing resource consumption and execution time of detection rules (Performance).
  • Provide evidence of specific environment factors influencing customized rule tuning (Contextual Tuning).
  • Provide evidence of improvements made by modifying sensitivity by changing alert triggering thresholds (Threshold Adjustments).
  • Provide evidence of refining rules to better detect deviations from typical behavior (Behavioral Tuning).
  • Provide evidence of improvements of adjusting rules based on time-based patterns (Temporal Tuning).
  • Provide reasoning of adjusting priority or severity levels of alerts (Severity Tuning).
  • Provide evidence of improving quality integrity of our data used by detection rules (Data Quality).
  • Ensure the tuning includes necessary updates to the release documentation and versioning.

Rule Metadata Checks

  • updated_date matches the date of tuning PR merged.
  • min_stack_version should support the widest stack versions.
  • name and description should be descriptive and not include typos.
  • query should be inclusive, not overly exclusive. Review to ensure the original intent of the rule is maintained.

Testing and Validation

  • Validate that the tuned rule's performance is satisfactory and does not negatively impact the stack.
  • Ensure that the tuned rule has a low false positive rate.

@shashank-elastic shashank-elastic mentioned this pull request Feb 3, 2025
Closed
5 tasks
@botelastic botelastic bot added bbr Building Block Rules Domain: Cloud Domain: Endpoint Integration: AWS AWS related rules Integration: Okta okta related rules ML machine learning related rule OS: Linux OS: macOS OS: Windows windows related rules python Internal python for the repository labels Feb 3, 2025
@shashank-elastic shashank-elastic removed Integration: AWS AWS related rules Domain: Cloud OS: Linux OS: macOS ML machine learning related rule Integration: Okta okta related rules labels Feb 3, 2025
@shashank-elastic shashank-elastic added patch and removed OS: Windows windows related rules Domain: Endpoint python Internal python for the repository bbr Building Block Rules labels Feb 3, 2025
@botelastic botelastic bot added bbr Building Block Rules Domain: Cloud Domain: Endpoint Integration: AWS AWS related rules Integration: Okta okta related rules ML machine learning related rule OS: Linux OS: macOS OS: Windows windows related rules python Internal python for the repository labels Feb 3, 2025
@eric-forte-elastic
Copy link
Contributor

Just as a note, before this merges I think we need to announce a maintenance window or is that no longer the case?

#4433 (review)

@shashank-elastic
Copy link
Contributor Author

Just as a note, before this merges I think we need to announce a maintenance window or is that no longer the case?

#4433 (review)

@eric-forte-elastic yes we need to announce a maintenance window

Mikaayenson
Mikaayenson approved these changes Feb 3, 2025
View reviewed changes
Copy link
Contributor

@Mikaayenson Mikaayenson left a comment

Choose a reason for hiding this comment

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

lgtm. remember we need to open a maintenance window for backport fixes.

@shashank-elastic shashank-elastic merged commit 818467f into main Feb 3, 2025
12 checks passed
@shashank-elastic shashank-elastic deleted the fix_master_links branch February 3, 2025 15:57
eric-forte-elastic pushed a commit that referenced this pull request Feb 3, 2025
@shashank-elastic @eric-forte-elastic
Replace master doc URLs with current (#4439)
b4102a6 
Removed changes from:
- rules/integrations/aws/impact_s3_object_encryption_with_external_key.toml
- rules/integrations/aws/persistence_iam_user_created_access_keys_for_another_user.toml
- rules/integrations/aws/privilege_escalation_iam_administratoraccess_policy_attached_to_group.toml
- rules/integrations/aws/privilege_escalation_iam_administratoraccess_policy_attached_to_role.toml
- rules/integrations/aws/privilege_escalation_iam_administratoraccess_policy_attached_to_user.toml
- rules/integrations/okta/defense_evasion_first_occurence_public_app_client_credential_token_exchange.toml
- rules/linux/command_and_control_linux_proxychains_activity.toml
- rules/linux/command_and_control_linux_ssh_x11_forwarding.toml
- rules/linux/command_and_control_linux_suspicious_proxychains_activity.toml
- rules/linux/command_and_control_linux_tunneling_and_port_forwarding.toml
- rules/linux/command_and_control_tunneling_via_earthworm.toml
- rules/linux/persistence_chkconfig_service_add.toml
- rules/linux/persistence_dynamic_linker_backup.toml
- rules/linux/persistence_init_d_file_creation.toml
- rules/linux/persistence_insmod_kernel_module_load.toml
- rules/linux/persistence_kde_autostart_modification.toml
- rules/linux/persistence_kworker_file_creation.toml
- rules/linux/persistence_linux_backdoor_user_creation.toml
- rules/linux/persistence_linux_shell_activity_via_web_server.toml
- rules/linux/persistence_linux_user_added_to_privileged_group.toml
- rules/linux/persistence_message_of_the_day_execution.toml
- rules/linux/persistence_setuid_setgid_capability_set.toml
- rules/ml/persistence_ml_rare_process_by_host_windows.toml
- rules/ml/persistence_ml_windows_anomalous_process_all_hosts.toml
- rules/ml/persistence_ml_windows_anomalous_process_creation.toml
- rules/windows/command_and_control_certreq_postdata.toml
- rules/windows/command_and_control_remote_file_copy_desktopimgdownldr.toml
- rules/windows/command_and_control_remote_file_copy_mpcmdrun.toml
- rules/windows/command_and_control_remote_file_copy_scripts.toml
- rules/windows/command_and_control_teamviewer_remote_file_copy.toml
- rules/windows/credential_access_bruteforce_admin_account.toml
- rules/windows/credential_access_bruteforce_multiple_logon_failure_followed_by_success.toml
- rules/windows/credential_access_bruteforce_multiple_logon_failure_same_srcip.toml
- rules/windows/credential_access_copy_ntds_sam_volshadowcp_cmdline.toml
- rules/windows/credential_access_credential_dumping_msbuild.toml
- rules/windows/credential_access_kerberoasting_unusual_process.toml
- rules/windows/credential_access_lsass_memdump_file_created.toml
- rules/windows/credential_access_lsass_memdump_handle_access.toml
- rules/windows/credential_access_persistence_network_logon_provider_modification.toml
- rules/windows/credential_access_suspicious_comsvcs_imageload.toml
- rules/windows/credential_access_wireless_creds_dumping.toml
- rules/windows/defense_evasion_adding_the_hidden_file_attribute_with_via_attribexe.toml
- rules/windows/defense_evasion_amsi_bypass_dllhijack.toml
- rules/windows/defense_evasion_amsi_bypass_powershell.toml
- rules/windows/defense_evasion_code_signing_policy_modification_builtin_tools.toml
- rules/windows/defense_evasion_code_signing_policy_modification_registry.toml
- rules/windows/defense_evasion_execution_lolbas_wuauclt.toml
- rules/windows/defense_evasion_execution_msbuild_started_renamed.toml
- rules/windows/defense_evasion_from_unusual_directory.toml
- rules/windows/defense_evasion_masquerading_renamed_autoit.toml
- rules/windows/defense_evasion_masquerading_werfault.toml
- rules/windows/defense_evasion_misc_lolbin_connecting_to_the_internet.toml
- rules/windows/defense_evasion_msbuild_making_network_connections.toml
- rules/windows/defense_evasion_network_connection_from_windows_binary.toml
- rules/windows/defense_evasion_posh_assembly_load.toml
- rules/windows/defense_evasion_posh_compressed.toml
- rules/windows/defense_evasion_rundll32_no_arguments.toml
- rules/windows/defense_evasion_suspicious_certutil_commands.toml
- rules/windows/defense_evasion_suspicious_process_access_direct_syscall.toml
- rules/windows/defense_evasion_suspicious_short_program_name.toml
- rules/windows/defense_evasion_suspicious_zoom_child_process.toml
- rules/windows/defense_evasion_system_critical_proc_abnormal_file_activity.toml
- rules/windows/defense_evasion_unusual_ads_file_creation.toml
- rules/windows/defense_evasion_via_filter_manager.toml
- rules/windows/discovery_privileged_localgroup_membership.toml
- rules/windows/execution_command_prompt_connecting_to_the_internet.toml
- rules/windows/execution_command_shell_started_by_svchost.toml
- rules/windows/execution_from_unusual_path_cmdline.toml
- rules/windows/execution_html_help_executable_program_connecting_to_the_internet.toml
- rules/windows/execution_posh_hacktool_functions.toml
- rules/windows/execution_posh_portable_executable.toml
- rules/windows/execution_posh_psreflect.toml
- rules/windows/execution_register_server_program_connecting_to_the_internet.toml
- rules/windows/execution_via_compiled_html_file.toml
- rules/windows/lateral_movement_remote_services.toml
- rules/windows/persistence_adobe_hijack_persistence.toml
- rules/windows/persistence_appinitdlls_registry.toml
- rules/windows/persistence_evasion_registry_startup_shell_folder_modified.toml
- rules/windows/persistence_powershell_profiles.toml
- rules/windows/persistence_priv_escalation_via_accessibility_features.toml
- rules/windows/persistence_service_windows_service_winlog.toml
- rules/windows/persistence_startup_folder_file_written_by_suspicious_process.toml
- rules/windows/persistence_startup_folder_scripts.toml
- rules/windows/persistence_suspicious_image_load_scheduled_task_ms_office.toml
- rules/windows/persistence_system_shells_via_services.toml
- rules/windows/persistence_time_provider_mod.toml
- rules/windows/persistence_via_update_orchestrator_service_hijack.toml
- rules/windows/privilege_escalation_named_pipe_impersonation.toml
- rules/windows/privilege_escalation_posh_token_impersonation.toml
- rules/windows/privilege_escalation_service_control_spawned_script_int.toml
- rules/windows/privilege_escalation_uac_bypass_event_viewer.toml
- rules/windows/privilege_escalation_uac_bypass_mock_windir.toml
- rules/windows/privilege_escalation_uac_bypass_winfw_mmc_hijack.toml
- rules/windows/privilege_escalation_unusual_parentchild_relationship.toml
- rules_building_block/command_and_control_certutil_network_connection.toml

(selectively cherry picked from commit 818467f)
eric-forte-elastic pushed a commit that referenced this pull request Feb 3, 2025
@shashank-elastic @eric-forte-elastic
Replace master doc URLs with current (#4439)
8696670 
Removed changes from:
- rules/integrations/okta/defense_evasion_first_occurence_public_app_client_credential_token_exchange.toml
- rules/ml/persistence_ml_rare_process_by_host_windows.toml
- rules/ml/persistence_ml_windows_anomalous_process_all_hosts.toml
- rules/ml/persistence_ml_windows_anomalous_process_creation.toml
- rules/windows/command_and_control_certreq_postdata.toml
- rules/windows/command_and_control_remote_file_copy_desktopimgdownldr.toml
- rules/windows/command_and_control_remote_file_copy_mpcmdrun.toml
- rules/windows/command_and_control_remote_file_copy_scripts.toml
- rules/windows/credential_access_bruteforce_admin_account.toml
- rules/windows/credential_access_bruteforce_multiple_logon_failure_followed_by_success.toml
- rules/windows/credential_access_bruteforce_multiple_logon_failure_same_srcip.toml
- rules/windows/credential_access_copy_ntds_sam_volshadowcp_cmdline.toml
- rules/windows/credential_access_credential_dumping_msbuild.toml
- rules/windows/credential_access_lsass_memdump_file_created.toml
- rules/windows/credential_access_lsass_memdump_handle_access.toml
- rules/windows/credential_access_persistence_network_logon_provider_modification.toml
- rules/windows/credential_access_suspicious_comsvcs_imageload.toml
- rules/windows/credential_access_wireless_creds_dumping.toml
- rules/windows/defense_evasion_adding_the_hidden_file_attribute_with_via_attribexe.toml
- rules/windows/defense_evasion_amsi_bypass_dllhijack.toml
- rules/windows/defense_evasion_amsi_bypass_powershell.toml
- rules/windows/defense_evasion_code_signing_policy_modification_builtin_tools.toml
- rules/windows/defense_evasion_code_signing_policy_modification_registry.toml
- rules/windows/defense_evasion_execution_lolbas_wuauclt.toml
- rules/windows/defense_evasion_execution_msbuild_started_renamed.toml
- rules/windows/defense_evasion_from_unusual_directory.toml
- rules/windows/defense_evasion_masquerading_renamed_autoit.toml
- rules/windows/defense_evasion_masquerading_werfault.toml
- rules/windows/defense_evasion_misc_lolbin_connecting_to_the_internet.toml
- rules/windows/defense_evasion_msbuild_making_network_connections.toml
- rules/windows/defense_evasion_network_connection_from_windows_binary.toml
- rules/windows/defense_evasion_posh_assembly_load.toml
- rules/windows/defense_evasion_posh_compressed.toml
- rules/windows/defense_evasion_rundll32_no_arguments.toml
- rules/windows/defense_evasion_suspicious_certutil_commands.toml
- rules/windows/defense_evasion_suspicious_process_access_direct_syscall.toml
- rules/windows/defense_evasion_suspicious_short_program_name.toml
- rules/windows/defense_evasion_suspicious_zoom_child_process.toml
- rules/windows/defense_evasion_system_critical_proc_abnormal_file_activity.toml
- rules/windows/defense_evasion_unusual_ads_file_creation.toml
- rules/windows/defense_evasion_via_filter_manager.toml
- rules/windows/discovery_privileged_localgroup_membership.toml
- rules/windows/execution_command_prompt_connecting_to_the_internet.toml
- rules/windows/execution_command_shell_started_by_svchost.toml
- rules/windows/execution_from_unusual_path_cmdline.toml
- rules/windows/execution_html_help_executable_program_connecting_to_the_internet.toml
- rules/windows/execution_posh_hacktool_functions.toml
- rules/windows/execution_posh_portable_executable.toml
- rules/windows/execution_posh_psreflect.toml
- rules/windows/execution_register_server_program_connecting_to_the_internet.toml
- rules/windows/execution_via_compiled_html_file.toml
- rules/windows/lateral_movement_remote_services.toml
- rules/windows/persistence_adobe_hijack_persistence.toml
- rules/windows/persistence_appinitdlls_registry.toml
- rules/windows/persistence_evasion_registry_startup_shell_folder_modified.toml
- rules/windows/persistence_powershell_profiles.toml
- rules/windows/persistence_priv_escalation_via_accessibility_features.toml
- rules/windows/persistence_service_windows_service_winlog.toml
- rules/windows/persistence_startup_folder_file_written_by_suspicious_process.toml
- rules/windows/persistence_startup_folder_scripts.toml
- rules/windows/persistence_suspicious_image_load_scheduled_task_ms_office.toml
- rules/windows/persistence_system_shells_via_services.toml
- rules/windows/persistence_time_provider_mod.toml
- rules/windows/persistence_via_update_orchestrator_service_hijack.toml
- rules/windows/privilege_escalation_named_pipe_impersonation.toml
- rules/windows/privilege_escalation_posh_token_impersonation.toml
- rules/windows/privilege_escalation_service_control_spawned_script_int.toml
- rules/windows/privilege_escalation_uac_bypass_event_viewer.toml
- rules/windows/privilege_escalation_uac_bypass_mock_windir.toml
- rules/windows/privilege_escalation_uac_bypass_winfw_mmc_hijack.toml
- rules/windows/privilege_escalation_unusual_parentchild_relationship.toml
- rules_building_block/command_and_control_certutil_network_connection.toml

(selectively cherry picked from commit 818467f)
eric-forte-elastic pushed a commit that referenced this pull request Feb 3, 2025
@shashank-elastic @eric-forte-elastic
Replace master doc URLs with current (#4439)
2035859 
Removed changes from:
- rules/integrations/okta/defense_evasion_first_occurence_public_app_client_credential_token_exchange.toml

(selectively cherry picked from commit 818467f)
@shashank-elastic shashank-elastic mentioned this pull request Feb 3, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mikaayenson Mikaayenson Mikaayenson approved these changes

@Aegrah Aegrah Aegrah approved these changes

@eric-forte-elastic eric-forte-elastic Awaiting requested review from eric-forte-elastic eric-forte-elastic is a code owner

@terrancedejesus terrancedejesus Awaiting requested review from terrancedejesus terrancedejesus is a code owner

Assignees

@shashank-elastic shashank-elastic

Labels
backport: auto bbr Building Block Rules community Domain: Cloud Domain: Endpoint Integration: AWS AWS related rules Integration: Okta okta related rules meta:rapid-merge ML machine learning related rule OS: Linux OS: macOS OS: Windows windows related rules patch python Internal python for the repository Rule: Tuning tweaking or tuning an existing rule
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@shashank-elastic @eric-forte-elastic @Mikaayenson @Aegrah @lcawl