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.

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

[Rule Tuning] Tuning AWS STS Temporary Credentials via AssumeRole #4228

Merged

Conversation

terrancedejesus
Copy link
Contributor

@terrancedejesus terrancedejesus commented Nov 1, 2024

Pull Request

Issue link(s):

Summary - What I changed

  • Removed user.id from query as it is not always present in event docs, causing false-negatives to occur
  • Added exclusions for invocation by commonly used AWS service endpoints eoncifg, securityhub and sso at amazaonaws.com
  • Ignored AWS ARNs that indicate Amazon, Elastic, Wiz or DataDog
  • Adjusted new term values to focus on AWS ARN (typically role or user) and where this action was invoked by (EC2, Lambda, etc.). So if it is unusual for a user/role attached to a certain resource to make this call, flag it.

Note

This rule is expected to still generate global false-positives based on context mainly existing in user agent, which is not reliable to filter on. For example, we could ignore all AWS-CLI and AWS-SDK and that would remove 80% of alert volume. However, it would also potentially introduce false-negatives where TAs abuse OOTB AWS CLI on EC2 instances as an example. As such we have added an investigation guide that suggests adding custom exceptions for user-agent or ARN specifically is verifiable.

How To Test

Screenshot 2024-11-01 at 1 11 18 PM

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, 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

@terrancedejesus terrancedejesus added Integration: AWS AWS related rules Domain: Cloud Rule: Tuning tweaking or tuning an existing rule labels Nov 1, 2024
@terrancedejesus terrancedejesus self-assigned this Nov 1, 2024
@protectionsmachine
Copy link
Collaborator

protectionsmachine commented Nov 1, 2024

Rule: New - Guidelines

These guidelines serve as a reminder set of considerations when proposing a new rule.

Documentation and Context

  • Detailed description of the rule.
  • List any new fields required in ECS/data sources.
  • Link related issues or PRs.
  • Include references.

Rule Metadata Checks

  • creation_date matches the date of creation PR initially 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, considering performance for diverse environments. Non ecs fields should be added to non-ecs-schema.json if not available in an integration.
  • min_stack_comments and min_stack_version should be included if the rule is only compatible starting from a specific stack version.
  • index pattern should be neither too specific nor too vague, ensuring it accurately matches the relevant data stream (e.g., use logs-endpoint.process-* for process data).
  • integration should align with the index. If the integration is newly introduced, ensure the manifest, schemas, and new_rule.yaml template are updated.
  • setup should include the necessary steps to configure the integration.
  • note should include any additional information (e.g. Triage and analysis investigation guides, timeline templates).
  • tags should be relevant to the threat and align/added to the EXPECTED_RULE_TAGS in the definitions.py file.
  • threat, techniques, and subtechniques should map to ATT&CK always if possible.

New BBR Rules

  • building_block_type should be included if the rule is a building block and the rule should be located in the rules_building_block folder.
  • bypass_bbr_timing should be included if adding custom lookback timing to the rule.

Testing and Validation

  • Provide evidence of testing and detecting the expected threat.
  • Check for existence of coverage to prevent duplication.

@terrancedejesus terrancedejesus marked this pull request as ready for review November 1, 2024 16:49
@terrancedejesus terrancedejesus changed the title [Rule Tuning] Tuning 'AWS STS Temporary Credentials via AssumeRole' [Rule Tuning] Tuning AWS STS Temporary Credentials via AssumeRole Nov 1, 2024
@terrancedejesus terrancedejesus marked this pull request as draft November 1, 2024 17:34
@terrancedejesus terrancedejesus marked this pull request as ready for review November 1, 2024 18:04
Copy link
Contributor

@Aegrah Aegrah left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@imays11 imays11 left a comment

Choose a reason for hiding this comment

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

Looks good!

@terrancedejesus terrancedejesus added the Rule: New Proposal for new rule label Nov 6, 2024
@terrancedejesus terrancedejesus merged commit ef6344f into main Nov 6, 2024
9 checks passed
@terrancedejesus terrancedejesus deleted the rule-tuning-aws-sts-temporary-credentials-via-assumedrole branch November 6, 2024 17:01
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
…4228)

* tuning 'AWS STS Temporary Credentials via AssumeRole'

* linted; adjusted OR in quer

* added investigation guide

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

Co-authored-by: Ruben Groenewoud <[email protected]>

* added new rule 'AWS STS Role Assumption by User'

* adjusted UUID

* Update rules/integrations/aws/privilege_escalation_role_assumption_by_service.toml

---------

Co-authored-by: Ruben Groenewoud <[email protected]>
Co-authored-by: Isai <[email protected]>

(cherry picked from commit ef6344f)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
…4228)

* tuning 'AWS STS Temporary Credentials via AssumeRole'

* linted; adjusted OR in quer

* added investigation guide

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

Co-authored-by: Ruben Groenewoud <[email protected]>

* added new rule 'AWS STS Role Assumption by User'

* adjusted UUID

* Update rules/integrations/aws/privilege_escalation_role_assumption_by_service.toml

---------

Co-authored-by: Ruben Groenewoud <[email protected]>
Co-authored-by: Isai <[email protected]>

(cherry picked from commit ef6344f)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
…4228)

* tuning 'AWS STS Temporary Credentials via AssumeRole'

* linted; adjusted OR in quer

* added investigation guide

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

Co-authored-by: Ruben Groenewoud <[email protected]>

* added new rule 'AWS STS Role Assumption by User'

* adjusted UUID

* Update rules/integrations/aws/privilege_escalation_role_assumption_by_service.toml

---------

Co-authored-by: Ruben Groenewoud <[email protected]>
Co-authored-by: Isai <[email protected]>

(cherry picked from commit ef6344f)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
…4228)

* tuning 'AWS STS Temporary Credentials via AssumeRole'

* linted; adjusted OR in quer

* added investigation guide

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

Co-authored-by: Ruben Groenewoud <[email protected]>

* added new rule 'AWS STS Role Assumption by User'

* adjusted UUID

* Update rules/integrations/aws/privilege_escalation_role_assumption_by_service.toml

---------

Co-authored-by: Ruben Groenewoud <[email protected]>
Co-authored-by: Isai <[email protected]>

(cherry picked from commit ef6344f)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
…4228)

* tuning 'AWS STS Temporary Credentials via AssumeRole'

* linted; adjusted OR in quer

* added investigation guide

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

Co-authored-by: Ruben Groenewoud <[email protected]>

* added new rule 'AWS STS Role Assumption by User'

* adjusted UUID

* Update rules/integrations/aws/privilege_escalation_role_assumption_by_service.toml

---------

Co-authored-by: Ruben Groenewoud <[email protected]>
Co-authored-by: Isai <[email protected]>

(cherry picked from commit ef6344f)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
…4228)

* tuning 'AWS STS Temporary Credentials via AssumeRole'

* linted; adjusted OR in quer

* added investigation guide

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

* Update rules/integrations/aws/privilege_escalation_sts_temp_creds_via_assume_role.toml

Co-authored-by: Ruben Groenewoud <[email protected]>

* added new rule 'AWS STS Role Assumption by User'

* adjusted UUID

* Update rules/integrations/aws/privilege_escalation_role_assumption_by_service.toml

---------

Co-authored-by: Ruben Groenewoud <[email protected]>
Co-authored-by: Isai <[email protected]>

(cherry picked from commit ef6344f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport: auto Domain: Cloud Integration: AWS AWS related rules Rule: New Proposal for new rule Rule: Tuning tweaking or tuning an existing rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants