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

auditbeat,filebeat,packetbeat: format mac addresses according to ECS #32622

Merged
merged 7 commits into from
Aug 23, 2022

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Aug 8, 2022

What does this PR do?

This changes MAC address formatting to conform to the ECS specification.

Why is it important?

Currently MAC addresses are formatted in Go code using the net.HardwareAddr String method which does not conform to the ECS spec.

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.

Author's Checklist

  • In many cases hardware addresses are not generated by Go code. These cases are not handled in this change.
  • The formatting function is simple and there is no obvious place to put it, so it is duplicated at use sites.

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 added bug Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.4-candidate labels Aug 8, 2022
@efd6 efd6 self-assigned this Aug 8, 2022
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Aug 8, 2022
@efd6 efd6 force-pushed the 32621-all branch 2 times, most recently from 4323286 to 50b45fe Compare August 8, 2022 02:21
@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 8, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-08-23T21:54:44.053+0000

  • Duration: 78 min 56 sec

Test stats 🧪

Test Results
Failed 0
Passed 4147
Skipped 234
Total 4381

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review August 8, 2022 04:04
@efd6 efd6 requested a review from a team as a code owner August 8, 2022 04:04
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@mergify
Copy link
Contributor

mergify bot commented Aug 14, 2022

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b 32621-all upstream/32621-all
git merge upstream/main
git push upstream 32621-all

Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

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

The CEF processor (keys.ecs.go) is producing several MACs. You can add a Translate function to the mappings for each that replaces colons with dashes.

@mergify
Copy link
Contributor

mergify bot commented Aug 23, 2022

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b 32621-all upstream/32621-all
git merge upstream/main
git push upstream 32621-all

Comment on lines 135 to 136
in.String = strings.ToUpper(strings.ReplaceAll(in.String, ":", "-"))
return in.String, nil
Copy link
Member

Choose a reason for hiding this comment

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

I doubt it matters, but none of the other Translate funcs mutate *cef.Field. They only return the modified value. Perhaps it should be a straight return without the set.

Copy link
Contributor Author

@efd6 efd6 Aug 23, 2022

Choose a reason for hiding this comment

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

Fixed and added docs to mappedField.

Note for future: The mutation would be ineffective in this case.

chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
…32622)

* packetbeat,x-pack/{auditbeat,filebeat}: make MAC addresses render in ECS format
* x-pack/filebeat/processors/decode_cef: canonicalise MAC addresses for ECS fields

    This retains the original format in the cef.extension fields but ensures
    that the MAC address format used in ECS fields matches the spec.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.5-candidate backport-skip Skip notification from the automated backport with mergify bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants