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

CEF CheckPoint: adjust fields for forward compatibility #17681

Merged
merged 10 commits into from
Apr 14, 2020

Conversation

adriansr
Copy link
Contributor

@adriansr adriansr commented Apr 13, 2020

What does this PR do?

This PR makes some changes to CEF module's custom mappings for Check Point devices, to ensure compatibility with the upcoming checkpoint module.

Check Point has its custom log format, for which a new module is being prepared. The idea behind this new module as well as CEF custom mappings for Check Point (this PR), is to use ECS whenever possible and map the rest under checkpoint.* using the original field name from Check Point.

In the original PR for CEF, a few mistakes had been done in field names and types. Also taking the opportunity to change some ECS mappings.

Why is it important?

We want both CEF an checkpoint modules to define and populate the same fields, ECS and proprietary, and avoid having a breaking change in the future.

Checklist

  • My code follows the style guidelines of this project

  • I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation

  • I have made corresponding change to the default configuration files

  • I have added tests that prove my fix is effective or that my feature works

  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc. Not needed, feature is unreleased.

  • Relates [SIEM][CEF] Add support for Check Point devices #16907 Checkpoint Syslog Filebeat module #17682

We're trying to consolidate the field names under checkpoint.* and
file_hash is not an existing field. This removes the field and keeps the
data in the appropriate ECS field.

Also adds support for SHA-256, which the checkpoint supports, but it's
not documented in the CEF exporter.
This renames / changes types on some custom fields under checkpoint to
align with the names used in Check Point logs (not CEF), so that the
documents generated by the CEF module and the upcoming checkpoint module
are compatible.
That's the correct name for this field.
@elasticmachine
Copy link
Collaborator

Pinging @elastic/siem (Team:SIEM)

@adriansr adriansr added Filebeat Filebeat needs_backport PR is waiting to be backported to other branches. labels Apr 13, 2020
@adriansr adriansr requested a review from P1llus April 13, 2020 07:31
Copy link
Member

@P1llus P1llus left a comment

Choose a reason for hiding this comment

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

Added some comments, rest looks good to me!

@@ -5066,7 +5066,7 @@ type: ip
--
Protection performance impact.

type: keyword
type: long
Copy link
Member

Choose a reason for hiding this comment

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

This type can be set to integer

@@ -4895,7 +4895,7 @@ type: keyword
--
Confidence level determined.

type: keyword
type: long
Copy link
Member

Choose a reason for hiding this comment

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

This type should be changed to integer

Copy link
Member

@P1llus P1llus left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@@ -4895,7 +4895,7 @@ type: keyword
--
Confidence level determined.

type: keyword
type: integer
Copy link
Member

Choose a reason for hiding this comment

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

Is is this already a number in the event produced by the beat? Looks like it should be since it comes from deviceFlexNumber1 which is a long from the cef processor.

Copy link
Contributor

@leehinman leehinman left a comment

Choose a reason for hiding this comment

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

LGTM

@adriansr adriansr merged commit 4f6da4f into elastic:master Apr 14, 2020
@zube zube bot added [zube]: Done and removed [zube]: Inbox labels Apr 14, 2020
adriansr added a commit to adriansr/beats that referenced this pull request Apr 14, 2020
This PR makes some changes to CEF module's custom mappings for Check Point
devices to ensure compatibility with the upcoming checkpoint module.

Check Point has its custom log format, for which a new module is being
prepared. The idea behind this new module as well as CEF custom mappings for
Check Point (this PR), is to use ECS whenever possible and map the rest
under checkpoint.* using the original field name from Check Point.

In the original PR for CEF, a few mistakes had been done in field names and
types. Also taking the opportunity to change some ECS mappings.

Related elastic#16907 elastic#17682

(cherry picked from commit 4f6da4f)
@adriansr adriansr added v7.8.0 and removed needs_backport PR is waiting to be backported to other branches. labels Apr 14, 2020
adriansr added a commit to adriansr/beats that referenced this pull request Apr 14, 2020
This PR makes some changes to CEF module's custom mappings for Check Point
devices to ensure compatibility with the upcoming checkpoint module.

Check Point has its custom log format, for which a new module is being
prepared. The idea behind this new module as well as CEF custom mappings for
Check Point (this PR), is to use ECS whenever possible and map the rest
under checkpoint.* using the original field name from Check Point.

In the original PR for CEF, a few mistakes had been done in field names and
types. Also taking the opportunity to change some ECS mappings.

Related elastic#16907 elastic#17682

(cherry picked from commit 4f6da4f)
adriansr added a commit that referenced this pull request Apr 15, 2020
)

This PR makes some changes to CEF module's custom mappings for Check Point
devices to ensure compatibility with the upcoming checkpoint module.

Check Point has its custom log format, for which a new module is being
prepared. The idea behind this new module as well as CEF custom mappings for
Check Point (this PR), is to use ECS whenever possible and map the rest
under checkpoint.* using the original field name from Check Point.

In the original PR for CEF, a few mistakes had been done in field names and
types. Also taking the opportunity to change some ECS mappings.

Related #16907 #17682

(cherry picked from commit 4f6da4f)
adriansr added a commit that referenced this pull request Apr 15, 2020
)

This PR makes some changes to CEF module's custom mappings for Check Point
devices to ensure compatibility with the upcoming checkpoint module.

Check Point has its custom log format, for which a new module is being
prepared. The idea behind this new module as well as CEF custom mappings for
Check Point (this PR), is to use ECS whenever possible and map the rest
under checkpoint.* using the original field name from Check Point.

In the original PR for CEF, a few mistakes had been done in field names and
types. Also taking the opportunity to change some ECS mappings.

Related #16907 #17682

(cherry picked from commit 4f6da4f)
@zube zube bot removed the [zube]: Done label Oct 13, 2020
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
… (elastic#17712)

This PR makes some changes to CEF module's custom mappings for Check Point
devices to ensure compatibility with the upcoming checkpoint module.

Check Point has its custom log format, for which a new module is being
prepared. The idea behind this new module as well as CEF custom mappings for
Check Point (this PR), is to use ECS whenever possible and map the rest
under checkpoint.* using the original field name from Check Point.

In the original PR for CEF, a few mistakes had been done in field names and
types. Also taking the opportunity to change some ECS mappings.

Related elastic#16907 elastic#17682

(cherry picked from commit ddb92ca)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants