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

Addition of related.mac and related.port #2288

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

hisecu
Copy link

@hisecu hisecu commented Oct 5, 2023

At Leiden University we already use the related.port field, and internally there is a demand for
related.mac, which is even more important, and which is flagged as a "must have" by an end user.

In general, the aggregation of related values makes searches far easier for end users.
They do not need to know about all the field names that may contain a port number or a
MAC address, or all the various formats of MAC addresses that are possible.

The reason why related.mac is more important is, that a MAC address has many different
formats in ingest like log entries. Examples are colon-separated hex values like
FF:FF:FF:FF:FF:FF and ff:ff:ff:ff:ff:ff, flat formats like FFFFFFFFFFFF and ffffffffffff,
hyphen-separated values like FF-FF-FF-FF-FF-FF and ff-ff-ff-ff-ff-ff, and dot separated
values like FFFF.FFFF.FFFF and ffff.ffff.ffff. In fact, space separated and
IPv6 Modified EUI-64 are also possible. For the end user, it is difficult to work with this.
If all MAC addresses of all key names are aggregated in related.mac with a canonical format,
which is know to the end user, the search will be very easy.

A fictional example: There is new worm named BogusWorm that uses port 16511/tcp and which
offers a remote exploit to an attacker. It is not known yet whether this port is only used
for incoming traffic or for outgoing traffic as well. There are 30 different candidate
fields that may contain the port number. It makes it easy to be able to simply use a KQL
query like related.port : 16511

It would not surprise me, if the aggregation of even more fields/values would be useful,
our current request is limited to related.port and related.mac

  • Have you signed the contributor license agreement?
  • Have you followed the contributor guidelines?
  • For proposing substantial changes or additions to the schema, have you reviewed the RFC process?
  • If submitting code/script changes, have you verified all tests pass locally using make test?
  • If submitting schema/fields updates, have you generated new artifacts by running make and committed those changes?
  • Is your pull request against main? Unless there is a good reason otherwise, we prefer pull requests against main and will backport as needed.
  • Have you added an entry to the CHANGELOG.next.md?

@hisecu hisecu requested a review from a team as a code owner October 5, 2023 10:26
@cla-checker-service
Copy link

cla-checker-service bot commented Oct 5, 2023

💚 CLA has been signed

@hisecu
Copy link
Author

hisecu commented Oct 5, 2023

The contributor license agreement on https://www.elastic.co/contributor-agreement has been signed.

@ebeahan
Copy link
Member

ebeahan commented Oct 13, 2023

@hisecu would you please provide some additional details in the description about the proposed changes and how'd the changes would benefit ECS?

@hisecu
Copy link
Author

hisecu commented Oct 17, 2023

@ebeahan thanks for your feedback, is that here in the comments or elsewhere?

@ebeahan
Copy link
Member

ebeahan commented Oct 17, 2023

thanks for your feedback, is that here in the comments or elsewhere?

In the PR description is fine.

@hisecu
Copy link
Author

hisecu commented Oct 23, 2023

thanks for your feedback, is that here in the comments or elsewhere?

In the PR description is fine.

@ebeahan I edited the description above, is it ok like this?

Copy link

This PR is stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the stale Stale issues and pull requests label Dec 23, 2023
before they populate this array. For this, The notation format from RFC 7042 is suggested:
Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving
the value of the octet as an unsigned integer. Successive octets are separated by a
hyphen.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think an example would be useful here.

short: All the mac addresses seen on your event.
description: >
All the mac addresses seen on your event. The mac addresses should be standardized
before they populate this array. For this, The notation format from RFC 7042 is suggested:
Copy link
Contributor

Choose a reason for hiding this comment

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

typo in uppercase ..., The notation...

@ebeahan ebeahan removed the stale Stale issues and pull requests label Feb 23, 2024
Copy link

This PR is stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the stale Stale issues and pull requests label Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Stale issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants