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

Issue 998: Add Data Classification Profile #1007

Merged
merged 13 commits into from
Apr 11, 2024
Merged

Conversation

Aniak5
Copy link
Contributor

@Aniak5 Aniak5 commented Apr 2, 2024

Related Issue:

#998

Description of changes:

  • Added data_classification object
  • Added data_classification profile
  • Added data_classification profile to database, databucket, email, file, metadata, product, resource_details and web_resource objects
image image image image image image

@alanisaac
Copy link
Contributor

alanisaac commented Apr 2, 2024

Looks like this PR is picking up the latest version of the OCSF validator, which is now (technically, correctly) picking up more validation errors:

FATAL: File at events/network/file_activity.json does not pass metaschema validation. Error: 'optional' is not one of ['recommended', 'required'] at JSON path: '$.attributes.connection_info.requirement'

Either we need to fix the schema errors (likely in another PR) or pin the validator version fully.

@Aniak5
Copy link
Contributor Author

Aniak5 commented Apr 2, 2024

Looks like this PR is picking up the latest version of the OCSF validator, which is now (technically, correctly) picking up more validation errors:

FATAL: File at events/network/file_activity.json does not pass metaschema validation. Error: 'optional' is not one of ['recommended', 'required'] at JSON path: '$.attributes.connection_info.requirement'

Either we need to fix the schema errors (likely in another PR) or pin the validator version fully.

I can create a new PR to fix this.

@alanisaac
Copy link
Contributor

oh -- already on it! #1009

@Aniak5 Aniak5 force-pushed the issue-998 branch 2 times, most recently from 9622f84 to 95e29fb Compare April 5, 2024 20:34
@Aniak5 Aniak5 changed the title DRAFT: Issue 998: Add Data Classification Profile Issue 998: Add Data Classification Profile Apr 5, 2024
@Aniak5 Aniak5 added the non_breaking Non Breaking, backwards compatible changes label Apr 5, 2024
@Aniak5 Aniak5 requested review from query-jeremy and k2niner April 5, 2024 20:43
@k2niner
Copy link
Contributor

k2niner commented Apr 8, 2024

(1) data_type seems like a fairly generic attribute name for what we are trying to capture. When I see that name, I certainly expect something else in the larger context of OCSF. I believe we want something like a Data Sensitivity Category, which is clearly way too long of a name, but does that capture the need?

(2) I would need to extend the object for my use case, but this might get me out of the business of extending some of the objects that I extend now, which is a win. I assume I could also have the profile applied to other objects within my extension, right?

(3) I apply a classification object to product as a means of capturing the "high water mark" of the product (i.e., web application) that was accessed. Worth considering.

@Aniak5
Copy link
Contributor Author

Aniak5 commented Apr 9, 2024

(1) data_type seems like a fairly generic attribute name for what we are trying to capture. When I see that name, I certainly expect something else in the larger context of OCSF. I believe we want something like a Data Sensitivity Category, which is clearly way too long of a name, but does that capture the need?

Agreed, maybe something more simple like category or category_type? It exists within the data_classification object so we likely don't need data appended.

(2) I would need to extend the object for my use case, but this might get me out of the business of extending some of the objects that I extend now, which is a win. I assume I could also have the profile applied to other objects within my extension, right?

Yes, exactly!

(3) I apply a classification object to product as a means of capturing the "high water mark" of the product (i.e., web application) that was accessed. Worth considering.

We can certainly add the profile to the product object as well. Though this makes me wonder if we should add product to additional objects. Which OCSF object does product belong to in your example?

@k2niner
Copy link
Contributor

k2niner commented Apr 9, 2024

We can certainly add the profile to the product object as well. Though this makes me wonder if we should add product to additional objects. Which OCSF object does product belong to in your example?

For a Web Resource Activity event, I apply a classification object to:

metadata - captures the sensitivity of the event log
product - inside metadata, this product attribute captures the high water mark of the sensitivity of the data hosted by the product (app)
web_resource - captures the sensitivity of the resource that was accessed.

I have two other uses, but they are unique to my extended object.

Signed-off-by: Ania Kacewicz <[email protected]>
@Aniak5
Copy link
Contributor Author

Aniak5 commented Apr 10, 2024

Tagging Jonathan @jonrau-at-queryai here because I cannot add him as a reviewer.

Signed-off-by: Ania Kacewicz <[email protected]>
Copy link
Contributor

@jonrau-at-queryai jonrau-at-queryai left a comment

Choose a reason for hiding this comment

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

LGTM! Awesome work with this 🚢

Copy link
Contributor

@zschmerber zschmerber left a comment

Choose a reason for hiding this comment

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

This is so helpful thanks for adding the profile.

@floydtree floydtree merged commit 6670992 into ocsf:main Apr 11, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
non_breaking Non Breaking, backwards compatible changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants