diff --git a/rfcs/text/0000-file-fields.md b/rfcs/text/0000-fileorigin-fields.md similarity index 78% rename from rfcs/text/0000-file-fields.md rename to rfcs/text/0000-fileorigin-fields.md index 171b125b80..ecf051c7df 100644 --- a/rfcs/text/0000-file-fields.md +++ b/rfcs/text/0000-fileorigin-fields.md @@ -1,4 +1,4 @@ -# 0000: File Events Fields +# 0000: File Origin Fields - Stage: **0 (strawperson)** @@ -13,16 +13,20 @@ Feel free to remove these comments as you go along. Stage 0: Provide a high level summary of the premise of these changes. Briefly describe the nature, purpose, and impact of the changes. ~2-5 sentences. --> -This RFC adds two new fields in the file fields: `file.origin_referrer_url` and `file.origin_url`. -In Windows, it is known that when downloading files from the internet using a web browser (eg. Chrome, Edge, etc), information about the file's source, known as the Mark of the Web, is added to the file's NTFS alternate data stream. -For example, when you download an image file (`image17.webp`) from [this webpage](https://www.elastic.co/security-labs/pikabot-i-choose-you) using a web browser, the download source URL is automatically added to the file's Alternate Data Stream (ADS) as following. +It is known that when downloading files from the internet using a web browser (eg. Chrome, Edge, etc), information about the file's source is added to the file. +In Windows, it is known as the Mark of the Web and stored in file's Alternate Data Stream (ADS). In MacOS, it is stored in file's extended file attributes (metadata). + +For example, in Windows, when you download an image file (`image17.webp`) from [this webpage](https://www.elastic.co/security-labs/pikabot-i-choose-you) using a web browser, the download source URL is automatically added to the file's Alternate Data Stream (ADS) as following. image * Inside `image17.webp:Zone.Identifier:$DATA` image -This PR adds a field to store the URL of the file's origin, which is saved in the NTFS alternate data stream (ADS). The ReferrerUrl is intended to be stored in the `origin_referrer_url field`, and the `HostUrl` is inteded to be stored in the `origin_url` field. +In ensuring endpoint security, the origin information of a file is crucial for determining whether a downloaded file or executable from the internet comes from a safe source and if it is safe to execute. + +Thus, this PR adds new fields to store the URL of the file's origin information for `file`, `process`, and `dll`. +The ReferrerUrl is intended to be stored in the `origin_referrer_url` field, and the `HostUrl` is inteded to be stored in the `origin_url` field. The ZoneId is intended to be stored in the `zone_identifier` field. -The new `file` fields proposed are: +The new fields proposed are: Field | Type | Description /Usage -- | -- | -- file.origin_referrer_url | keyword | The URL of the webpage that linked to the file. file.origin_url | keyword | The URL where the file is hosted. - +process.origin_referrer_url | keyword | The URL of the webpage that linked to the file. +process.origin_url | keyword | The URL where the file is hosted. +process.zone_identifier | short | Numerical identifier that indicates the security zone of a file's origin. +dll.origin_referrer_url | keyword | The URL of the webpage that linked to the file. +dll.origin_url | keyword | The URL where the file is hosted. +dll.zone_identifier | short | Numerical identifier that indicates the security zone of a file's origin.