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

Add a new meta schema keyword: family, to group related classes in a category #1334

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

pagbabian-splunk
Copy link
Contributor

Related Issue: #1261

Description of changes:

Added a new meta schema keyword called family which like the group keyword does with attributes, can tag related event classes. This could be used to organize related classes in a category that don't have contiguous IDs, which cause them to sort randomly as the classes have been created in time. A large number of classes in a category can also be collapsed into a label, as another example (e.g. a large list of OT protocols in the Network category).

Delete once you have confirmed the following:

  1. Did you add a single line summary of changes to Unreleased section in the CHANGELOG.md file?

…favor of an updated email_activity class.

Updated the email object to include domains, files, urls arrays.
Updated the email_activity class to add the message_trace_uid ID.
Updated the email_activity class to use the references[] for the Trace activity_id instead of the description URL.
Updated the email_activity class description to reflect its SMTP protocol and the possible URLs and files attachments.

Signed-off-by: Paul Agbabian <[email protected]>
Signed-off-by: Paul Agbabian <[email protected]>
…ed an at_least_one constraint on all the to and from attributes. Not all email logs have the 'to' and 'from' but must have at least those or 'smtp_to' and 'smtp_from' in the log.

Signed-off-by: Paul Agbabian <[email protected]>
…egory. Updated the Discovery classes with their families of Query, Inventory, State.

Signed-off-by: Paul Agbabian <[email protected]>
…_famil

Add back changes for the family keywords to conflicting classes for Discoveryy

Signed-off-by: Paul Agbabian <[email protected]>
@pagbabian-splunk pagbabian-splunk added enhancement New feature or request framework Structures, conventions, requirements, data types, etc. non_breaking Non Breaking, backwards compatible changes metaschema v1.5.0 or later labels Feb 4, 2025
Copy link
Contributor

@alanisaac alanisaac left a comment

Choose a reason for hiding this comment

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

Minor question: other categorization schemes in OCSF, like group and requirement for attributes are lower-case. Should family be as well? For this use case at least, it seems more like an enum than a description.

@pagbabian-splunk
Copy link
Contributor Author

Minor question: other categorization schemes in OCSF, like group and requirement for attributes are lower-case. Should family be as well? For this use case at least, it seems more like an enum than a description.

Yes, the intent was for it to be similar to group and requirement where the value is a string, rather than an enum. The difference is that for group and requirement the set of values are well known and limited, while for family it is more like a single phrase caption or short description, and a grouping function would need to be aware of that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request framework Structures, conventions, requirements, data types, etc. metaschema non_breaking Non Breaking, backwards compatible changes v1.5.0 or later
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants