logstash-codec-cef 6.0.1-java → 6.2.1-java

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dd13e0f9bfc0b86dcd6d9f3f9b062a10ecb14113bf4c2064d3fdee3067b1cca2
4
- data.tar.gz: 62193bfe55ae9faebb85ddc6c734c80125df69a91fe5c7a922dd91e6f2785acd
3
+ metadata.gz: f530caa2c56a19a914e3482cb063a998b8e43807975e1523b2c73156aa7e2fbe
4
+ data.tar.gz: d8cada7fc621d62b5ec0ccc3e8e8c8c6dfc401fbbecfa7a5b70c43eed9cd0cea
5
5
  SHA512:
6
- metadata.gz: bd27d064fa1a760dbf1f8c9afe53d0c3b1d561c3d195c199ae2748b3c4067bff64b4abd838f6413811f863e4adcf7ec6403c215ae04d038741198f94ea325922
7
- data.tar.gz: 6038f059336b2e5dd896716d577cae12a6798ff850b9b4ac7f28312e863de931f9fa4b1ab189a3230dba38a9373f3c7c68814b1c1acc19296462bda3c95de19f
6
+ metadata.gz: 9aff57924314652538bcfb860bbded217955dbfede94f523069b2525e514d44711db5c7884dede93c38723b9b3eb5d5d5782b82bc5e7f0a624f97a664f601f26
7
+ data.tar.gz: a53cece29e66a40be33b49e0abaf898519bca82d611d56f0bfa3db034cece00d368741c3cd3afab3ccab888ab2c138ba97cca232d8a49ac1c28477459fdfc3ef
data/CHANGELOG.md CHANGED
@@ -1,3 +1,19 @@
1
+ ## 6.2.1
2
+ - Added field mapping to docs.
3
+ - Fixed ECS mapping of `deviceMacAddress` field.
4
+
5
+ ## 6.2.0
6
+ - Introduce ECS Compatibility mode [#83](https://github.com/logstash-plugins/logstash-codec-cef/pull/83).
7
+
8
+ ## 6.1.2
9
+ - Added error log with full payload when something bad happens in decoding a message[#84](https://github.com/logstash-plugins/logstash-codec-cef/pull/84)
10
+
11
+ ## 6.1.1
12
+ - Improved encoding performance, especially when encoding many extension fields [#81](https://github.com/logstash-plugins/logstash-codec-cef/pull/81)
13
+
14
+ ## 6.1.0
15
+ - Fixed CEF short to long name translation for ahost/agentHostName field, according to documentation [#75](https://github.com/logstash-plugins/logstash-codec-cef/pull/75)
16
+
1
17
  ## 6.0.1
2
18
  - Fixed support for deep dot notation [#73](https://github.com/logstash-plugins/logstash-codec-cef/pull/73)
3
19
 
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2020 Elastic and contributors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Logstash Plugin
2
2
 
3
- [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-codec-cef.svg)](https://travis-ci.org/logstash-plugins/logstash-codec-cef)
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-codec-cef.svg)](https://travis-ci.com/logstash-plugins/logstash-codec-cef)
4
4
 
5
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
6
 
data/docs/index.asciidoc CHANGED
@@ -27,14 +27,299 @@ https://community.saas.hpe.com/dcvta86296/attachments/dcvta86296/connector-docum
27
27
  If this codec receives a payload from an input that is not a valid CEF message, then it will
28
28
  produce an event with the payload as the 'message' field and a '_cefparsefailure' tag.
29
29
 
30
+ ==== Compatibility with the Elastic Common Schema (ECS)
31
+
32
+ This plugin can be used to decode CEF events _into_ the Elastic Common Schema, or to encode ECS-compatible events into CEF.
33
+ It can also be used _without_ ECS, encoding and decoding events using only CEF-defined field names and keys.
34
+
35
+ The ECS Compatibility mode for a specific plugin instance can be controlled by setting <<plugins-{type}s-{plugin}-ecs_compatibility>> when defining the codec:
36
+
37
+ [source,sh]
38
+ -----
39
+ input {
40
+ tcp {
41
+ # ...
42
+ codec => cef {
43
+ ecs_compatibility => v1
44
+ }
45
+ }
46
+ }
47
+ -----
48
+
49
+ If left unspecified, the value of the `pipeline.ecs_compatibility` setting is used.
50
+
51
+ ===== Timestamps and ECS compatiblity
52
+
53
+ When decoding in ECS Compatibility Mode, timestamp-type fields are parsed and normalized
54
+ to specific points on the timeline.
55
+
56
+ Because the CEF format allows ambiguous timestamp formats, some reasonable assumptions are made:
57
+
58
+ - When the timestamp does not include a year, we assume it happened in the recent past
59
+ (or _very_ near future to accommodate out-of-sync clocks and timezone offsets).
60
+ - When the timestamp does not include UTC-offset information, we use the event's
61
+ timezone (`dtz` or `deviceTimeZone` field), or fall through to this plugin's
62
+ <<plugins-{type}s-{plugin}-default_timezone>>.
63
+ - Localized timestamps are parsed using the provided <<plugins-{type}s-{plugin}-locale>>.
64
+
65
+ [id="plugins-{type}s-{plugin}-field-mapping"]
66
+ ===== Field mapping
67
+
68
+ The header fields from each CEF payload is expanded to the following fields, depending on whether ECS is enabled.
69
+
70
+ [id="plugins-{type}s-{plugin}-header-field"]
71
+ ====== Header field mapping
72
+ |=====
73
+ |ECS Disabled | ECS Field
74
+
75
+ |`cefVersion` |`[cef][version]`
76
+ |`deviceVendor` |`[observer][vendor]`
77
+ |`deviceProduct` |`[observer][product]`
78
+ |`deviceVersion` |`[observer][version]`
79
+ |`deviceEventClassId`|`[event][code]`
80
+ |`name` |`[cef][name]`
81
+ |`severity` |`[event][severity]`
82
+ |=====
83
+
84
+ When decoding CEF payloads with `ecs_compatibility => disabled`, the abbreviated CEF Keys found in extensions are expanded, and CEF Field Names are inserted at the root level of the event.
85
+
86
+ When decoding in an ECS Compatibility mode, the ECS Fields are populated from the corresponding CEF Field Names _or_ CEF Keys found in the payload's extensions.
87
+
88
+ The following is a mapping between these fields.
89
+
90
+ // Templates for short-hand notes in the table below
91
+ :cef-ambiguous-higher: pass:quotes[Multiple possible CEF fields map to this ECS Field. When decoding, the last entry encountered wins. When encoding, this field has _higher_ priority.]
92
+ :cef-ambiguous-lower: pass:quotes[Multiple possible CEF fields map to this ECS Field. When decoding, the last entry encountered wins. When encoding, this field has _lower_ priority.]
93
+ :cef-normalize-timestamp: pass:quotes[This field contains a timestamp. In ECS Compatibility Mode, it is parsed to a specific point in time.]
94
+ :cef-plugin-config-condition: pass:quotes[When plugin configured with]
95
+
96
+
97
+ [id="plugins-{type}s-{plugin}-ext-field"]
98
+ ====== Extension field mapping
99
+ |=======================================================================================================================
100
+ |CEF Field Name (optional CEF Key) |ECS Field
101
+
102
+ |`agentAddress` (`agt`) |`[agent][ip]`
103
+ |`agentDnsDomain` |`[cef][agent][registered_domain]`
104
+
105
+ {cef-ambiguous-higher}
106
+ |`agentHostName` (`ahost`) |`[agent][name]`
107
+ |`agentId` (`aid`) |`[agent][id]`
108
+ |`agentMacAddress` (`amac`) |`[agent][mac]`
109
+ |`agentNtDomain` |`[cef][agent][registered_domain]`
110
+
111
+ {cef-ambiguous-lower}
112
+ |`agentReceiptTime` (`art`) |`[event][created]`
113
+
114
+ {cef-normalize-timestamp}
115
+ |`agentTimeZone` (`atz`) |`[cef][agent][timezone]`
116
+ |`agentTranslatedAddress` |`[cef][agent][nat][ip]`
117
+ |`agentTranslatedZoneExternalID` |`[cef][agent][translated_zone][external_id]`
118
+ |`agentTranslatedZoneURI` |`[cef][agent][translated_zone][uri]`
119
+ |`agentType` (`at`) |`[agent][type]`
120
+ |`agentVersion` (`av`) |`[agent][version]`
121
+ |`agentZoneExternalID` |`[cef][agent][zone][external_id]`
122
+ |`agentZoneURI` |`[cef][agent][zone][uri]`
123
+ |`applicationProtocol` (`app`) |`[network][protocol]`
124
+ |`baseEventCount` (`cnt`) |`[cef][base_event_count]`
125
+ |`bytesIn` (`in`) |`[source][bytes]`
126
+ |`bytesOut` (`out`) |`[destination][bytes]`
127
+ |`categoryDeviceType` (`catdt`) |`[cef][device_type]`
128
+ |`customerExternalID` |`[organization][id]`
129
+ |`customerURI` |`[organization][name]`
130
+ |`destinationAddress` (`dst`) |`[destination][ip]`
131
+ |`destinationDnsDomain` |`[destination][registered_domain]`
132
+
133
+ {cef-ambiguous-higher}
134
+ |`destinationGeoLatitude` (`dlat`) |`[destination][geo][location][lat]`
135
+ |`destinationGeoLongitude` (`dlong`) |`[destination][geo][location][lon]`
136
+ |`destinationHostName` (`dhost`) |`[destination][domain]`
137
+ |`destinationMacAddress` (`dmac`) |`[destination][mac]`
138
+ |`destinationNtDomain` (`dntdom`) |`[destination][registered_domain]`
139
+
140
+ {cef-ambiguous-lower}
141
+ |`destinationPort` (`dpt`) |`[destination][port]`
142
+ |`destinationProcessId` (`dpid`) |`[destination][process][pid]`
143
+ |`destinationProcessName` (`dproc`) |`[destination][process][name]`
144
+ |`destinationServiceName` |`[destination][service][name]`
145
+ |`destinationTranslatedAddress` |`[destination][nat][ip]`
146
+ |`destinationTranslatedPort` |`[destination][nat][port]`
147
+ |`destinationTranslatedZoneExternalID` |`[cef][destination][translated_zone][external_id]`
148
+ |`destinationTranslatedZoneURI` |`[cef][destination][translated_zone][uri]`
149
+ |`destinationUserId` (`duid`) |`[destination][user][id]`
150
+ |`destinationUserName` (`duser`) |`[destination][user][name]`
151
+ |`destinationUserPrivileges` (`dpriv`) |`[destination][user][group][name]`
152
+ |`destinationZoneExternalID` |`[cef][destination][zone][external_id]`
153
+ |`destinationZoneURI` |`[cef][destination][zone][uri]`
154
+ |`deviceAction` (`act`) |`[event][action]`
155
+ .2+|`deviceAddress` (`dvc`) |`[observer][ip]`
156
+
157
+ {cef-plugin-config-condition} `device => observer`
158
+ |`[host][ip]`
159
+
160
+ {cef-plugin-config-condition} `device => host`
161
+ |`deviceCustomFloatingPoint1` (`cfp1`) |`[cef][device_custom_floating_point_1][value]`
162
+ |`deviceCustomFloatingPoint1Label` (`cfp1Label`)|`[cef][device_custom_floating_point_1][label]`
163
+ |`deviceCustomFloatingPoint2` (`cfp2`) |`[cef][device_custom_floating_point_2][value]`
164
+ |`deviceCustomFloatingPoint2Label` (`cfp2Label`)|`[cef][device_custom_floating_point_2][label]`
165
+ |`deviceCustomFloatingPoint3` (`cfp3`) |`[cef][device_custom_floating_point_3][value]`
166
+ |`deviceCustomFloatingPoint3Label` (`cfp3Label`)|`[cef][device_custom_floating_point_3][label]`
167
+ |`deviceCustomFloatingPoint4` (`cfp4`) |`[cef][device_custom_floating_point_4][value]`
168
+ |`deviceCustomFloatingPoint4Label` (`cfp4Label`)|`[cef][device_custom_floating_point_4][label]`
169
+ |`deviceCustomIPv6Address1` (`c6a1`) |`[cef][device_custom_ipv6_address_1][value]`
170
+ |`deviceCustomIPv6Address1Label` (`c6a1Label`) |`[cef][device_custom_ipv6_address_1][label]`
171
+ |`deviceCustomIPv6Address2` (`c6a2`) |`[cef][device_custom_ipv6_address_2][value]`
172
+ |`deviceCustomIPv6Address2Label` (`c6a2Label`) |`[cef][device_custom_ipv6_address_2][label]`
173
+ |`deviceCustomIPv6Address3` (`c6a3`) |`[cef][device_custom_ipv6_address_3][value]`
174
+ |`deviceCustomIPv6Address3Label` (`c6a3Label`) |`[cef][device_custom_ipv6_address_3][label]`
175
+ |`deviceCustomIPv6Address4` (`c6a4`) |`[cef][device_custom_ipv6_address_4][value]`
176
+ |`deviceCustomIPv6Address4Label` (`c6a4Label`) |`[cef][device_custom_ipv6_address_4][label]`
177
+ |`deviceCustomNumber1` (`cn1`) |`[cef][device_custom_number_1][value]`
178
+ |`deviceCustomNumber1Label` (`cn1Label`) |`[cef][device_custom_number_1][label]`
179
+ |`deviceCustomNumber2` (`cn2`) |`[cef][device_custom_number_2][value]`
180
+ |`deviceCustomNumber2Label` (`cn2Label`) |`[cef][device_custom_number_2][label]`
181
+ |`deviceCustomNumber3` (`cn3`) |`[cef][device_custom_number_3][value]`
182
+ |`deviceCustomNumber3Label` (`cn3Label`) |`[cef][device_custom_number_3][label]`
183
+ |`deviceCustomString1` (`cs1`) |`[cef][device_custom_string_1][value]`
184
+ |`deviceCustomString1Label` (`cs1Label`) |`[cef][device_custom_string_1][label]`
185
+ |`deviceCustomString2` (`cs2`) |`[cef][device_custom_string_2][value]`
186
+ |`deviceCustomString2Label` (`cs2Label`) |`[cef][device_custom_string_2][label]`
187
+ |`deviceCustomString3` (`cs3`) |`[cef][device_custom_string_3][value]`
188
+ |`deviceCustomString3Label` (`cs3Label`) |`[cef][device_custom_string_3][label]`
189
+ |`deviceCustomString4` (`cs4`) |`[cef][device_custom_string_4][value]`
190
+ |`deviceCustomString4Label` (`cs4Label`) |`[cef][device_custom_string_4][label]`
191
+ |`deviceCustomString5` (`cs5`) |`[cef][device_custom_string_5][value]`
192
+ |`deviceCustomString5Label` (`cs5Label`) |`[cef][device_custom_string_5][label]`
193
+ |`deviceCustomString6` (`cs6`) |`[cef][device_custom_string_6][value]`
194
+ |`deviceCustomString6Label` (`cs6Label`) |`[cef][device_custom_string_6][label]`
195
+ |`deviceDirection` |`[network][direction]`
196
+ .2+|`deviceDnsDomain` |`[observer][registered_domain]`
197
+
198
+ {cef-plugin-config-condition} `device => observer`.
199
+ |`[host][registered_domain]`
200
+
201
+ {cef-plugin-config-condition} `device => host`.
202
+ |`deviceEventCategory` (`cat`) |`[cef][category]`
203
+ .2+|`deviceExternalId` |`[observer][name]`
204
+
205
+ {cef-plugin-config-condition} `device => observer`.
206
+ |`[host][id]`
207
+
208
+ {cef-plugin-config-condition} `device => host`.
209
+ |`deviceFacility` |`[log][syslog][facility][code]`
210
+ .2+|`deviceHostName` (`dvchost`) |`[observer][hostname]`
211
+
212
+ {cef-plugin-config-condition} `device => observer`.
213
+ |`[host][name]`
214
+
215
+ {cef-plugin-config-condition} `device => host`.
216
+ |`deviceInboundInterface` |`[observer][ingress][interface][name]`
217
+ .2+|`deviceMacAddress` (`dvcmac`) |`[observer][mac]`
218
+
219
+ {cef-plugin-config-condition} `device => observer`.
220
+ |`[host][mac]`
221
+
222
+ {cef-plugin-config-condition} `device => host`.
223
+ |`deviceNtDomain` |`[cef][nt_domain]`
224
+ |`deviceOutboundInterface` |`[observer][egress][interface][name]`
225
+ |`devicePayloadId` |`[cef][payload_id]`
226
+ |`deviceProcessId` (`dvcpid`) |`[process][pid]`
227
+ |`deviceProcessName` |`[process][name]`
228
+ |`deviceReceiptTime` (`rt`) |`@timestamp`
229
+
230
+ {cef-normalize-timestamp}
231
+ |`deviceTimeZone` (`dtz`) |`[event][timezone]`
232
+ |`deviceTranslatedAddress` |`[host][nat][ip]`
233
+ |`deviceTranslatedZoneExternalID` |`[cef][translated_zone][external_id]`
234
+ |`deviceTranslatedZoneURI` |`[cef][translated_zone][uri]`
235
+ |`deviceVersion` |`[observer][version]`
236
+ |`deviceZoneExternalID` |`[cef][zone][external_id]`
237
+ |`deviceZoneURI` |`[cef][zone][uri]`
238
+ |`endTime` (`end`) |`[event][end]`
239
+
240
+ {cef-normalize-timestamp}
241
+ |`eventId` |`[event][id]`
242
+ |`eventOutcome` (`outcome`) |`[event][outcome]`
243
+ |`externalId` |`[cef][external_id]`
244
+ |`fileCreateTime` |`[file][created]`
245
+ |`fileHash` |`[file][hash]]`
246
+ |`fileId` |`[file][inode]`
247
+ |`fileModificationTime` |`[file][mtime]`
248
+
249
+ {cef-normalize-timestamp}
250
+ |`fileName` (`fname`) |`[file][name]`
251
+ |`filePath` |`[file][path]`
252
+ |`filePermission` |`[file][group]`
253
+ |`fileSize` (`fsize`) |`[file][size]`
254
+ |`fileType` |`[file][extension]`
255
+ |`managerReceiptTime` (`mrt`) |`[event][ingested]`
256
+
257
+ {cef-normalize-timestamp}
258
+ |`message` (`msg`) |`[message]`
259
+ |`oldFileCreateTime` |`[cef][old_file][created]`
260
+
261
+ {cef-normalize-timestamp}
262
+ |`oldFileHash` |`[cef][old_file][hash]`
263
+ |`oldFileId` |`[cef][old_file][inode]`
264
+ |`oldFileModificationTime` |`[cef][old_file][mtime]`
265
+
266
+ {cef-normalize-timestamp}
267
+ |`oldFileName` |`[cef][old_file][name]`
268
+ |`oldFilePath` |`[cef][old_file][path]`
269
+ |`oldFilePermission` |`[cef][old_file][group]`
270
+ |`oldFileSize` |`[cef][old_file][size]`
271
+ |`oldFileType` |`[cef][old_file][extension]`
272
+ |`rawEvent` |`[event][original]`
273
+ |`Reason` (`reason`) |`[event][reason]`
274
+ |`requestClientApplication` |`[user_agent][original]`
275
+ |`requestContext` |`[http][request][referrer]`
276
+ |`requestCookies` |`[cef][request][cookies]`
277
+ |`requestMethod` |`[http][request][method]`
278
+ |`requestUrl` (`request`) |`[url][original]`
279
+ |`sourceAddress` (`src`) |`[source][ip]`
280
+ |`sourceDnsDomain` |`[source][registered_domain]`
281
+
282
+ {cef-ambiguous-higher}
283
+ |`sourceGeoLatitude` (`slat`) |`[source][geo][location][lat]`
284
+ |`sourceGeoLongitude` (`slong`) |`[source][geo][location][lon]`
285
+ |`sourceHostName` (`shost`) |`[source][domain]`
286
+ |`sourceMacAddress` (`smac`) |`[source][mac]`
287
+ |`sourceNtDomain` (`sntdom`) |`[source][registered_domain]`
288
+
289
+ {cef-ambiguous-lower}
290
+ |`sourcePort` (`spt`) |`[source][port]`
291
+ |`sourceProcessId` (`spid`) |`[source][process][pid]`
292
+ |`sourceProcessName` (`sproc`) |`[source][process][name]`
293
+ |`sourceServiceName` |`[source][service][name]`
294
+ |`sourceTranslatedAddress` |`[source][nat][ip]`
295
+ |`sourceTranslatedPort` |`[source][nat][port]`
296
+ |`sourceTranslatedZoneExternalID` |`[cef][source][translated_zone][external_id]`
297
+ |`sourceTranslatedZoneURI` |`[cef][source][translated_zone][uri]`
298
+ |`sourceUserId` (`suid`) |`[source][user][id]`
299
+ |`sourceUserName` (`suser`) |`[source][user][name]`
300
+ |`sourceUserPrivileges` (`spriv`) |`[source][user][group][name]`
301
+ |`sourceZoneExternalID` |`[cef][source][zone][external_id]`
302
+ |`sourceZoneURI` |`[cef][source][zone][uri]`
303
+ |`startTime` (`start`) |`[event][start]`
304
+
305
+ {cef-normalize-timestamp}
306
+ |`transportProtocol` (`proto`) |`[network][transport]`
307
+ |`type` |`[cef][type]`
308
+ |=======================================================================================================================
309
+
310
+
30
311
  [id="plugins-{type}s-{plugin}-options"]
31
312
  ==== Cef Codec Configuration Options
32
313
 
33
314
  [cols="<,<,<",options="header",]
34
315
  |=======================================================================
35
316
  |Setting |Input type|Required
317
+ | <<plugins-{type}s-{plugin}-default_timezone>> |<<string,string>>|No
36
318
  | <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
319
+ | <<plugins-{type}s-{plugin}-device>> |<<string,string>>|No
320
+ | <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
37
321
  | <<plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
322
+ | <<plugins-{type}s-{plugin}-locale>> |<<string,string>>|No
38
323
  | <<plugins-{type}s-{plugin}-name>> |<<string,string>>|No
39
324
  | <<plugins-{type}s-{plugin}-product>> |<<string,string>>|No
40
325
  | <<plugins-{type}s-{plugin}-reverse_mapping>> |<<boolean,boolean>>|No
@@ -46,6 +331,21 @@ produce an event with the payload as the 'message' field and a '_cefparsefailure
46
331
 
47
332
  &nbsp;
48
333
 
334
+ [id="plugins-{type}s-{plugin}-default_timezone"]
335
+ ===== `default_timezone`
336
+
337
+ * Value type is <<string,string>>
338
+ * Supported values are:
339
+ ** https://en.wikipedia.org/wiki/List_of_tz_database_time_zones[Timezone names] (such as `Europe/Moscow`, `America/Argentina/Buenos_Aires`)
340
+ ** UTC Offsets (such as `-08:00`, `+03:00`)
341
+ * The default value is your system time zone
342
+ * This option has no effect when _encoding_.
343
+
344
+ When parsing timestamp fields in ECS mode and encountering timestamps that
345
+ do not contain UTC-offset information, the `deviceTimeZone` (`dtz`) field
346
+ from the CEF payload is used to interpret the given time. If the event does
347
+ not include timezone information, this `default_timezone` is used instead.
348
+
49
349
  [id="plugins-{type}s-{plugin}-delimiter"]
50
350
  ===== `delimiter`
51
351
 
@@ -69,21 +369,71 @@ This setting allows the following character sequences to have special meaning:
69
369
  * `\\r` (backslash "r") - means carriage return (ASCII 0x0D)
70
370
  * `\\n` (backslash "n") - means newline (ASCII 0x0A)
71
371
 
372
+ [id="plugins-{type}s-{plugin}-device"]
373
+ ===== `device`
374
+
375
+ * Value type is <<string,string>>
376
+ * Supported values are:
377
+ ** `observer`: indicates that device-specific fields represent the device used to _observe_ the event.
378
+ ** `host`: indicates that device-specific fields represent the device on which the event _occurred_.
379
+ * The default value for this setting is `observer`.
380
+ * Option has no effect when <<plugins-{type}s-{plugin}-ecs_compatibility,`ecs_compatibility => disabled`>>.
381
+ * Option has no effect when _encoding_
382
+
383
+ Defines a set of device-specific CEF fields as either representing the device on which an
384
+ event _occurred_, or merely the device from which the event was _observed_.
385
+ This causes the relevant fields to be routed to either the `host` or the `observer`
386
+ top-level groupings.
387
+
388
+ If the codec handles data from a variety of sources, the ECS recommendation is to use `observer`.
389
+
390
+ [id="plugins-{type}s-{plugin}-ecs_compatibility"]
391
+ ===== `ecs_compatibility`
392
+
393
+ * Value type is <<string,string>>
394
+ * Supported values are:
395
+ ** `disabled`: uses CEF-defined field names in the event (e.g., `bytesIn`, `sourceAddress`)
396
+ ** `v1`: supports ECS-compatible event fields (e.g., `[source][bytes]`, `[source][ip]`)
397
+ * Default value depends on which version of Logstash is running:
398
+ ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
399
+ ** Otherwise, the default value is `disabled`.
400
+
401
+ Controls this plugin's compatibility with the
402
+ {ecs-ref}[Elastic Common Schema (ECS)]
403
+ (ECS)].
404
+
72
405
  [id="plugins-{type}s-{plugin}-fields"]
73
406
  ===== `fields`
74
407
 
75
408
  * Value type is <<array,array>>
76
409
  * Default value is `[]`
410
+ * Option has no effect when _decoding_
411
+
412
+ When this codec is used in an Output Plugin, a list of fields can be provided to be included in CEF extensions part as key/value pairs.
413
+
414
+ [id="plugins-{type}s-{plugin}-locale"]
415
+ ===== `locale`
77
416
 
78
- Fields to be included in CEV extension part as key/value pairs
417
+ * Value type is <<string,string>>
418
+ * Supported values are:
419
+ ** Abbreviated language_COUNTRY format (e.g., `en_GB`, `pt_BR`)
420
+ ** Valid https://tools.ietf.org/html/bcp47[IETF BCP 47] language tag (e.g., `zh-cmn-Hans-CN`)
421
+ * The default value is your system locale
422
+ * Option has no effect when _encoding_
423
+
424
+ When parsing timestamp fields in ECS mode and encountering timestamps in
425
+ a localized format, this `locale` is used to interpret locale-specific strings
426
+ such as month abbreviations.
79
427
 
80
428
  [id="plugins-{type}s-{plugin}-name"]
81
429
  ===== `name`
82
430
 
83
431
  * Value type is <<string,string>>
84
432
  * Default value is `"Logstash"`
433
+ * Option has no effect when _decoding_
85
434
 
86
- Name field in CEF header. The new value can include `%{foo}` strings
435
+ When this codec is used in an Output Plugin, this option can be used to specify the
436
+ value of the name field in the CEF header. The new value can include `%{foo}` strings
87
437
  to help you build a new value from other parts of the event.
88
438
 
89
439
  [id="plugins-{type}s-{plugin}-product"]
@@ -91,8 +441,10 @@ to help you build a new value from other parts of the event.
91
441
 
92
442
  * Value type is <<string,string>>
93
443
  * Default value is `"Logstash"`
444
+ * Option has no effect when _decoding_
94
445
 
95
- Device product field in CEF header. The new value can include `%{foo}` strings
446
+ When this codec is used in an Output Plugin, this option can be used to specify the
447
+ value of the device product field in CEF header. The new value can include `%{foo}` strings
96
448
  to help you build a new value from other parts of the event.
97
449
 
98
450
 
@@ -101,6 +453,7 @@ to help you build a new value from other parts of the event.
101
453
 
102
454
  * Value type is <<boolean,boolean>>
103
455
  * Default value is `false`
456
+ * Option has no effect when _decoding_
104
457
 
105
458
  Set to true to adhere to the specifications and encode using the CEF key name (short name) for the CEF field names.
106
459
 
@@ -109,8 +462,10 @@ Set to true to adhere to the specifications and encode using the CEF key name (s
109
462
 
110
463
  * Value type is <<string,string>>
111
464
  * Default value is `"6"`
465
+ * Option has no effect when _decoding_
112
466
 
113
- Severity field in CEF header. The new value can include `%{foo}` strings
467
+ When this codec is used in an Output Plugin, this option can be used to specify the
468
+ value of the severity field in CEF header. The new value can include `%{foo}` strings
114
469
  to help you build a new value from other parts of the event.
115
470
 
116
471
  Defined as field of type string to allow sprintf. The value will be validated
@@ -122,8 +477,10 @@ All invalid values will be mapped to the default of 6.
122
477
 
123
478
  * Value type is <<string,string>>
124
479
  * Default value is `"Logstash"`
480
+ * Option has no effect when _decoding_
125
481
 
126
- Signature ID field in CEF header. The new value can include `%{foo}` strings
482
+ When this codec is used in an Output Plugin, this option can be used to specify the
483
+ value of the signature ID field in CEF header. The new value can include `%{foo}` strings
127
484
  to help you build a new value from other parts of the event.
128
485
 
129
486
  [id="plugins-{type}s-{plugin}-vendor"]
@@ -131,8 +488,10 @@ to help you build a new value from other parts of the event.
131
488
 
132
489
  * Value type is <<string,string>>
133
490
  * Default value is `"Elasticsearch"`
491
+ * Option has no effect when _decoding_
134
492
 
135
- Device vendor field in CEF header. The new value can include `%{foo}` strings
493
+ When this codec is used in an Output Plugin, this option can be used to specify the
494
+ value of the device vendor field in CEF header. The new value can include `%{foo}` strings
136
495
  to help you build a new value from other parts of the event.
137
496
 
138
497
  [id="plugins-{type}s-{plugin}-version"]
@@ -140,8 +499,8 @@ to help you build a new value from other parts of the event.
140
499
 
141
500
  * Value type is <<string,string>>
142
501
  * Default value is `"1.0"`
502
+ * Option has no effect when _decoding_
143
503
 
144
- Device version field in CEF header. The new value can include `%{foo}` strings
504
+ When this codec is used in an Output Plugin, this option can be used to specify the
505
+ value of the device version field in CEF header. The new value can include `%{foo}` strings
145
506
  to help you build a new value from other parts of the event.
146
-
147
-