-
Notifications
You must be signed in to change notification settings - Fork 0
/
win_event_log_renderer.go
296 lines (276 loc) · 9.31 KB
/
win_event_log_renderer.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
// +build 386 windows,amd64 windows
// Copyright 2018 StreamSets Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package rendering
import (
"github.com/satori/go.uuid"
log "github.com/sirupsen/logrus"
"github.com/spf13/cast"
"github.com/streamsets/datacollector-edge/api"
wincommon "github.com/streamsets/datacollector-edge/stages/origins/windows/common"
winevtcommon "github.com/streamsets/datacollector-edge/stages/origins/windows/wineventlog/common"
"strconv"
"unsafe"
)
type RawEventPopulationStrategy string
const (
BufferSizeDefault = uint32(8 * 1024)
PopulateRawEventXMLAlways = "ALWAYS"
PopulateRawEventXMLOnError = "ON_ERROR"
)
var (
SizeOfEvtVariant = int(unsafe.Sizeof(winevtcommon.EvtVariant{}))
)
type WinEventLogRenderer struct {
bufferSize int
rawEventPopulationStrategy RawEventPopulationStrategy
bufferForRender []byte
publisherManager *winEventLogPublisherManager
evtCreateRenderContextHandle winevtcommon.EventRenderContextHandle
}
func (weler *WinEventLogRenderer) RenderBookmark(bookmarkHandle winevtcommon.BookmarkHandle) (string, error) {
var bookmark string
returnBytes, _, _, err := weler.render(
winevtcommon.EventHandle(uintptr(bookmarkHandle)),
winevtcommon.EventRenderContextHandle(0),
winevtcommon.EvtRenderBookmark,
)
if err == nil {
bookmark, err = wincommon.ExtractString(returnBytes[:])
}
return bookmark, err
}
func (weler *WinEventLogRenderer) RenderEvent(
stageContext api.StageContext,
eventHandle winevtcommon.EventHandle,
bookmarkHandle winevtcommon.BookmarkHandle,
) (api.Record, error) {
var err error
var record api.Record
if weler.evtCreateRenderContextHandle == 0 {
weler.evtCreateRenderContextHandle, err =
winevtcommon.EvtCreateRenderContext(winevtcommon.EvtRenderContextSystem)
if err != nil {
log.WithError(err).Errorf("Error creating rendering context for system")
}
}
if err == nil {
var recordIdString string
populateRawEventXML := weler.rawEventPopulationStrategy == PopulateRawEventXMLAlways
log.Debugf("Populating Raw Event XML : %s %v", weler.rawEventPopulationStrategy, populateRawEventXML)
var systemData interface{}
eventField := make(map[string]interface{})
if err == nil {
systemData, err = weler.renderSystemData(eventHandle)
if err == nil {
eventField["System"] = systemData
if systemData != nil {
var providerName string
recordIdString, providerName, err = getRecordIdAndProviderName(systemData)
if err == nil {
eventField["Message"], err = weler.renderMessageStrings(eventHandle, providerName)
if err != nil {
log.WithError(err).Warn("Error rendering message strings")
populateRawEventXML = true
err = nil
}
}
}
}
//Populate the raw event xml field if the populate raw event xml flag was set or if there was an error
log.Debugf("Populating Raw Event XML : %v %v", populateRawEventXML, err != nil)
if populateRawEventXML || err != nil {
eventXMLString, err := weler.renderEventXML(eventHandle)
if err == nil {
eventField["rawEventXML"] = eventXMLString
} else {
log.WithError(err).Error("Error rendering raw event XML")
}
}
if recordIdString == "" {
recordIdString = uuid.NewV4().String()
}
record, err = stageContext.CreateRecord(recordIdString, eventField)
if err != nil {
log.WithError(err).Error("Error creating record")
}
if err == nil {
winevtcommon.EvtUpdateBookmark(bookmarkHandle, eventHandle)
}
}
}
return record, err
}
func (weler *WinEventLogRenderer) Close() {
if weler.publisherManager != nil {
weler.publisherManager.Close()
}
if weler.evtCreateRenderContextHandle != 0 {
weler.evtCreateRenderContextHandle.Close()
}
}
//private methods
func (weler *WinEventLogRenderer) renderMessageStrings(
eventHandle winevtcommon.EventHandle,
provider string,
) (string, error) {
var message string
publisherHandle, err := weler.publisherManager.GetPublisherHandle(provider)
if err == nil {
dwBufferUsed := uint32(0)
if err = winevtcommon.EvtFormatMessage(
publisherHandle,
eventHandle,
winevtcommon.EvtFormatMessageEvent,
uint32(len(weler.bufferForRender)),
&weler.bufferForRender[0],
&dwBufferUsed,
); err != nil {
if err == winevtcommon.ErrorInsufficientBuffer && weler.bufferSize == -1 {
log.Debugf(
"Insufficient Buffer for rendering with length: %d. Retrying with Buffer of size: %d",
len(weler.bufferForRender),
dwBufferUsed,
)
weler.bufferForRender = make([]byte, dwBufferUsed)
err = winevtcommon.EvtFormatMessage(
publisherHandle,
eventHandle,
winevtcommon.EvtFormatMessageEvent,
uint32(len(weler.bufferForRender)),
&weler.bufferForRender[0],
&dwBufferUsed,
)
} else {
log.WithError(err).Error("Error formatting message strings")
}
}
if err == nil {
message, err = wincommon.ExtractString(weler.bufferForRender[:])
}
}
return message, err
}
func (weler *WinEventLogRenderer) renderSystemData(eventHandle winevtcommon.EventHandle) (interface{}, error) {
systemProperties := make(map[string]interface{})
var err error
if err == nil {
var buf []byte
var propertyCount uint32
buf, _, propertyCount, err = weler.render(
eventHandle,
weler.evtCreateRenderContextHandle,
winevtcommon.EvtRenderEventValues,
)
if err == nil {
propertyId := 0
start := 0
end := SizeOfEvtVariant
for propertyId < int(propertyCount) {
bufSlice := buf[start:end]
evtVariant := (*winevtcommon.EvtVariant)(unsafe.Pointer(&bufSlice[0]))
data := evtVariant.GetData()
if data != nil {
systemProperties[winevtcommon.SystemPropertyIds[propertyId]] = data
}
start = end
end += SizeOfEvtVariant
propertyId += 1
}
} else {
}
} else {
log.WithError(err).Error("Error rendering system data")
}
return systemProperties, err
}
func (weler *WinEventLogRenderer) renderEventXML(eventHandle winevtcommon.EventHandle) (string, error) {
var err error
var buf []byte
var eventXmlString string
buf, _, _, err = weler.render(eventHandle, 0, winevtcommon.EvtRenderEventXml)
if err == nil {
eventXmlString, err = wincommon.ExtractString(buf)
}
return eventXmlString, err
}
func (weler *WinEventLogRenderer) render(
eventHandle winevtcommon.EventHandle,
eventRenderContextHandle winevtcommon.EventRenderContextHandle,
flags winevtcommon.EvtRenderFlag,
) ([]byte, uint32, uint32, error) {
dwBufferUsed := uint32(0)
dwPropertyCount := uint32(0)
err := winevtcommon.EvtRender(
eventRenderContextHandle,
eventHandle,
flags,
uint32(len(weler.bufferForRender)),
&weler.bufferForRender[0],
&dwBufferUsed,
&dwPropertyCount,
)
if err != nil && err == winevtcommon.ErrorInsufficientBuffer && weler.bufferSize == -1 {
log.Debugf(
"Insufficient Buffer for rendering with length: %d. Retrying with Buffer of size: %d",
len(weler.bufferForRender),
dwBufferUsed,
)
weler.bufferForRender = make([]byte, dwBufferUsed)
err = winevtcommon.EvtRender(
eventRenderContextHandle,
eventHandle,
flags,
uint32(len(weler.bufferForRender)),
&weler.bufferForRender[0],
&dwBufferUsed,
&dwPropertyCount,
)
}
if err != nil {
log.WithError(err).Errorf("Render Failed")
}
return weler.bufferForRender, dwBufferUsed, dwPropertyCount, err
}
func getRecordIdAndProviderName(systemData interface{}) (string, string, error) {
providerName := cast.ToString(getPropertyFromSystemData(systemData, winevtcommon.EvtSystemProviderName))
recordId := cast.ToUint64(getPropertyFromSystemData(systemData, winevtcommon.EvtSystemEventRecordId))
computerName := cast.ToString(getPropertyFromSystemData(systemData, winevtcommon.EvtSystemComputer))
channel := cast.ToString(getPropertyFromSystemData(systemData, winevtcommon.EvtSystemChannel))
timeCreated := cast.ToTime(getPropertyFromSystemData(systemData, winevtcommon.EvtSystemTimeCreated))
recordIdString := computerName + "::" + channel + "::" +
strconv.FormatUint(recordId, 10) + "::" +
strconv.FormatInt(wincommon.ConvertTimeToLong(timeCreated), 10)
return recordIdString, providerName, nil
}
func getPropertyFromSystemData(
systemData interface{},
propertyId winevtcommon.EvtSystemPropertyId,
) interface{} {
return cast.ToStringMap(systemData)[winevtcommon.SystemPropertyIds[propertyId]]
}
func NewWinEventLogRenderer(bufferSize int, rawEventPopulationStrategy RawEventPopulationStrategy) *WinEventLogRenderer {
bufferSizeValue := BufferSizeDefault
if bufferSize != -1 {
bufferSizeValue = uint32(bufferSize)
}
publisherManager := &winEventLogPublisherManager{
providerToPublisherMetadataHandle: map[string]winevtcommon.PublisherMetadataHandle{},
}
return &WinEventLogRenderer{
bufferSize: bufferSize,
rawEventPopulationStrategy: rawEventPopulationStrategy,
bufferForRender: make([]byte, bufferSizeValue),
publisherManager: publisherManager,
}
}