Skip to content

Add new policy fields for firewall_anti_tamper plugin #637

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

Merged
matthewh-elastic merged 3 commits into from
Jun 13, 2025
Merged

Add new policy fields for firewall_anti_tamper plugin #637

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1d87a1
add firewall_anti_tamper fields
matthewh-elastic Jun 12, 2025
f9f8baa
add firewall_anti_tamper fields
matthewh-elastic Jun 12, 2025
2b310ea
convert to diagnostic, add sample field
matthewh-elastic Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions custom_documentation/doc/endpoint/policy/policy_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ This is a state management document that is generated every time Endpoint refres
| Endpoint.policy.applied.response.configurations.behavior_protection.status |
| Endpoint.policy.applied.response.configurations.events.concerned_actions |
| Endpoint.policy.applied.response.configurations.events.status |
| Endpoint.policy.applied.response.configurations.firewall_anti_tamper.concerned_actions |
| Endpoint.policy.applied.response.configurations.firewall_anti_tamper.status |
| Endpoint.policy.applied.response.configurations.host_isolation.concerned_actions |
| Endpoint.policy.applied.response.configurations.host_isolation.status |
| Endpoint.policy.applied.response.configurations.logging.concerned_actions |
Expand Down
2 changes: 2 additions & 0 deletions custom_documentation/src/endpoint/data_stream/policy/policy_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ fields:
- Endpoint.policy.applied.response.configurations.behavior_protection.status
- Endpoint.policy.applied.response.configurations.events.concerned_actions
- Endpoint.policy.applied.response.configurations.events.status
- Endpoint.policy.applied.response.configurations.firewall_anti_tamper.concerned_actions
- Endpoint.policy.applied.response.configurations.firewall_anti_tamper.status
- Endpoint.policy.applied.response.configurations.host_isolation.concerned_actions
- Endpoint.policy.applied.response.configurations.host_isolation.status
- Endpoint.policy.applied.response.configurations.logging.concerned_actions
Expand Down
18 changes: 18 additions & 0 deletions custom_schemas/custom_endpoint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,24 @@
but not a simple sum of the actions
short: the overall status of memory_protection

- name: policy.applied.response.configurations.firewall_anti_tamper
level: custom
type: object
description: overall firewall_anti_tamper configuration and status of the applied policy

- name: policy.applied.response.configurations.firewall_anti_tamper.concerned_actions
level: custom
type: keyword
description: all actions that were taken for firewall_anti_tamper

- name: policy.applied.response.configurations.firewall_anti_tamper.status
level: custom
type: keyword
description: >
the overall status of firewall_anti_tamper, this is correlated to the status of concerned actions
but not a simple sum of the actions
short: the overall status of firewall_anti_tamper

Copy link
Contributor

@brian-mckinney brian-mckinney Jun 12, 2025

Choose a reason for hiding this comment

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

You could also add the example field to these definitions. It's useful for enhancing the auto generated docs (see: #606)

Copy link
Contributor Author

@matthewh-elastic matthewh-elastic Jun 13, 2025

Choose a reason for hiding this comment

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

Thanks. All of the fields for existing plugins are currently in the same format (eg here) so I copied these for consistency. Perhaps a separate PR could be raised to add the example field to all of them at once?

- name: policy.applied.response.configurations.streaming
level: custom
type: object
Expand Down
17 changes: 17 additions & 0 deletions package/endpoint/data_stream/policy/fields/fields.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,23 @@
ignore_above: 1024
description: the overall status of event collection, this is correlated to the status of concerned actions but not a simple sum of the actions
default_field: false
- name: policy.applied.response.configurations.firewall_anti_tamper
level: custom
type: object
description: overall firewall_anti_tamper configuration and status of the applied policy
default_field: false
- name: policy.applied.response.configurations.firewall_anti_tamper.concerned_actions
level: custom
type: keyword
ignore_above: 1024
description: all actions that were taken for firewall_anti_tamper
default_field: false
- name: policy.applied.response.configurations.firewall_anti_tamper.status
level: custom
type: keyword
ignore_above: 1024
description: the overall status of firewall_anti_tamper, this is correlated to the status of concerned actions but not a simple sum of the actions
default_field: false
- name: policy.applied.response.configurations.host_isolation.concerned_actions
level: custom
type: keyword
Expand Down
31 changes: 31 additions & 0 deletions schemas/v1/policy/policy.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.