Skip to content

Commit 83234cf

Browse files
Handle Executable and Read-Only files in the File object (ocsf#1438)
#### Related Issue: ocsf#1418 #### Description of changes: Added an `Executable File` enum value to the File object type_id enums. Added an `is_read-only` attribute to the dictionary and redefined it specifically in the `File` object. After discussion, we felt that treating executable files as distinct from regular files was warranted, vs. relying on the attributes of a file by the file system. The rationale I used was that the actual construction of the executable file is special, similar to a Symbolic Link being special, or a Folder being special - as they are distinguished currently in the enum list. --------- Signed-off-by: Paul Agbabian <pagbabian@splunk.com>
1 parent b7b83f8 commit 83234cf

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Thankyou! -->
5656
1. Added `Deleted` to `finding` `status_id` enum. [#1437](https://github.com/ocsf/ocsf-schema/pull/1437)
5757
1. Added `status` to `related_event` object. [#1434](https://github.com/ocsf/ocsf-schema/pull/1434)
5858
1. Added `attack_graph` to `finding_info`. [#1436](https://github.com/ocsf/ocsf-schema/pull/1436)
59+
1. Added `Executable File` to `file` `type_id` enum. Added `is_readonly` as an optional attribute. [#1438](https://github.com/ocsf/ocsf-schema/pull/1438)
5960

6061
### Misc
6162
1. Fixed spelling errors throughout the project and added spell checking to the CI linter workflow. [#1411](https://github.com/ocsf/ocsf-schema/pull/1411)
@@ -102,6 +103,7 @@ Thankyou! -->
102103
1. Added `tcp_state_id` as `integer_t`. [#1382](https://github.com/ocsf/ocsf-schema/pull/1382)
103104
1. Added `query_evidence` as type `query_evidence`. [#1382](https://github.com/ocsf/ocsf-schema/pull/1382)
104105
1. Added `checks` as type `check`. [#1369](https://github.com/ocsf/ocsf-schema/pull/1369)
106+
1. Added 'is_readonly' as type `boolean_t` with a "See specific usage" description. [#1438](https://github.com/ocsf/ocsf-schema/pull/1438)
105107
* #### Objects
106108
1. Added `assessment` object to capture evaluations/assessments of configurations/signals. [#1343](https://github.com/ocsf/ocsf-schema/pull/1343)
107109
1. Added `node`, `edge`, `graph` objects. [#1343](https://github.com/ocsf/ocsf-schema/pull/1343)

dictionary.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3155,6 +3155,11 @@
31553155
"description": "The indication of whether the email has been read.",
31563156
"type": "boolean_t"
31573157
},
3158+
"is_readonly": {
3159+
"caption": "Read-Only",
3160+
"description": "Indicates that an object cannot be modified. See specific usage",
3161+
"type": "boolean_t"
3162+
},
31583163
"is_remote": {
31593164
"caption": "Remote",
31603165
"description": "The indication of whether the session is remote.",

objects/file.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@
7373
"profile": "cloud",
7474
"requirement": "optional"
7575
},
76+
"is_readonly": {
77+
"description": "Indicates that the file cannot be modified.",
78+
"requirement": "optional"
79+
},
7680
"is_system": {
7781
"requirement": "optional"
7882
},
@@ -130,7 +134,7 @@
130134
"requirement": "optional"
131135
},
132136
"type_id": {
133-
"description": "The file type ID.",
137+
"description": "The file type ID. Note the distinction between a <code>Regular File</code> and an <code>Executable File</code>. If the distinction is not known, or not indicated by the log, use <code>Regular File</code>. In this case, it should not be assumed that a Regular File is not executable.",
134138
"enum": {
135139
"0": {
136140
"caption": "Unknown"
@@ -156,6 +160,9 @@
156160
"7": {
157161
"caption": "Symbolic Link"
158162
},
163+
"8": {
164+
"caption": "Executable File"
165+
},
159166
"99": {
160167
"caption": "Other"
161168
}

0 commit comments

Comments
 (0)