Repository navigation
[Security Solution][API docs] Document MITRE ATLAS support for rule threat mappings - #301025
Draft
nastasha-solomon wants to merge 2 commits into
Draft
nastasha-solomon wants to merge 2 commits into
nastasha-solomon wants to merge 2 commits into
Conversation
…hreat mappings Update the `Threat` schema description in the detection rules API so it no longer states that only MITRE ATT&CK is supported. Since 9.6, rules can carry MITRE ATLAS threat entries (elastic#296562, elastic#298185). - Describe both supported `framework` values, `MITRE ATT&CK` and `MITRE ATLAS`. - Note that ATLAS tactic and technique IDs use the `AML.` prefix. - State that each `threat` entry belongs to one framework and that ATT&CK and ATLAS IDs must not be mixed in the same entry. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
🤖 Jobs for this PR can be triggered through checkboxes. 🚧
ℹ️ To trigger the CI, please tick the checkbox below 👇
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the detection rules API reference so the rule
Threatobject no longer says that only MITRE ATT&CK is supported. Since 9.6 (#296562, #298185), rules can also carry MITRE ATLAS threat entries.Related docs PR: elastic/docs-content#9065
What changed
Only the source schema changed:
x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes.schema.yaml.ThreatThreat.frameworkMITRE ATT&CKandMITRE ATLAS(9.6 and later), with example IDs. Notes that ATLAS IDs use theAML.prefix.The
frameworkstrings matchTHREAT_FRAMEWORK_NAMEinx-pack/solutions/security/packages/security-mitre-attack-common/src/threat_framework.ts. The example IDs (TA0001,T1566,T1566.001,AML.TA0000,AML.T0044,AML.T0024.002) all exist in the bundled MITRE artifact.The API does not validate the
frameworkvalue or reject mixed IDs. The "don't mix" text is usage guidance, matching how #298185 treats it.Generated files
The derived files were not regenerated locally. CI quick checks (
pnpm openapi:generate,pnpm openapi:bundle:detections,make api-docs) are expected to regenerate and auto-commit them:common_attributes.gen.tsdocs/openapi/{ess,serverless}/security_solution_detections_api_2023_10_31.bundled.schema.yamloas_docs/output/*.yamlChecklist
release_note:breakinglabel should be applied in these situations. (N/A: description-only change, no schema shape change)release_note:*label is applied per the guidelinesbackport:*labels.Identify risks
None. This only changes OpenAPI descriptions; it doesn't change validation, types, or runtime behavior.
🤖 Generated with Claude Code