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

[Winlogbeat] Remove brittle configuration validation from wineventlog #21593

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions winlogbeat/eventlog/eventlogging.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,6 @@ const (
eventLoggingAPIName = "eventlogging"
)

var eventLoggingConfigKeys = common.MakeStringSet(append(commonConfigKeys,
"ignore_older", "read_buffer_size", "format_buffer_size")...)

type eventLoggingConfig struct {
ConfigCommon `config:",inline"`
IgnoreOlder time.Duration `config:"ignore_older"`
Expand Down Expand Up @@ -284,7 +281,7 @@ func newEventLogging(options *common.Config) (EventLog, error) {
ReadBufferSize: win.MaxEventBufferSize,
FormatBufferSize: win.MaxFormatMessageBufferSize,
}
if err := readConfig(options, &c, eventLoggingConfigKeys); err != nil {
if err := readConfig(options, &c); err != nil {
return nil, err
}

Expand Down
28 changes: 4 additions & 24 deletions winlogbeat/eventlog/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,9 @@ import (
"sort"
"strings"

"github.com/joeshaw/multierror"

"github.com/elastic/beats/v7/libbeat/common"
)

var commonConfigKeys = []string{"type", "api", "name", "fields", "fields_under_root",
"tags", "processors", "index", "id", "meta", "revision"}

// ConfigCommon is the common configuration data used to instantiate a new
// EventLog. Each implementation is free to support additional configuration
// options.
Expand All @@ -42,33 +37,18 @@ type validator interface {
Validate() error
}

func readConfig(
c *common.Config,
config interface{},
validKeys common.StringSet,
) error {
func readConfig(c *common.Config, config interface{}) error {
if err := c.Unpack(config); err != nil {
return fmt.Errorf("failed unpacking config. %v", err)
}

var errs multierror.Errors
if len(validKeys) > 0 {
// Check for invalid keys.
for _, k := range c.GetFields() {
if !validKeys.Has(k) {
errs = append(errs, fmt.Errorf("invalid event log key '%s' "+
"found. Valid keys are %s", k, strings.Join(validKeys.ToSlice(), ", ")))
}
}
}

if v, ok := config.(validator); ok {
if err := v.Validate(); err != nil {
errs = append(errs, err)
return err
}
}

return errs.Err()
return nil
}

// Producer produces a new event log instance for reading event log records.
Expand Down Expand Up @@ -114,7 +94,7 @@ func New(options *common.Config) (EventLog, error) {
}

var config ConfigCommon
if err := readConfig(options, &config, nil); err != nil {
if err := readConfig(options, &config); err != nil {
return nil, err
}

Expand Down
6 changes: 1 addition & 5 deletions winlogbeat/eventlog/wineventlog.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,6 @@ const (
winEventLogAPIName = "wineventlog"
)

var winEventLogConfigKeys = common.MakeStringSet(append(commonConfigKeys,
"batch_read_size", "ignore_older", "include_xml", "event_id", "forwarded",
"level", "provider", "no_more_events")...)

type winEventLogConfig struct {
ConfigCommon `config:",inline"`
BatchReadSize int `config:"batch_read_size"` // Maximum number of events that Read will return.
Expand Down Expand Up @@ -366,7 +362,7 @@ func (l *winEventLog) buildRecordFromXML(x []byte, recoveredErr error) (Record,
// using the Windows Event Log.
func newWinEventLog(options *common.Config) (EventLog, error) {
c := defaultWinEventLogConfig
if err := readConfig(options, &c, winEventLogConfigKeys); err != nil {
if err := readConfig(options, &c); err != nil {
return nil, err
}

Expand Down
2 changes: 1 addition & 1 deletion winlogbeat/eventlog/wineventlog_expirimental.go
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ func newWinEventLogExp(options *common.Config) (EventLog, error) {
cfgwarn.Experimental("The %s event log reader is experimental.", winEventLogExpAPIName)

c := winEventLogConfig{BatchReadSize: 512}
if err := readConfig(options, &c, winEventLogConfigKeys); err != nil {
if err := readConfig(options, &c); err != nil {
return nil, err
}

Expand Down
19 changes: 0 additions & 19 deletions winlogbeat/tests/system/test_eventlogging.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,25 +156,6 @@ def test_ignore_older(self):
self.assertEqual(evts[0]["winlog.event_id"], 10)
self.assertEqual(evts[0]["event.code"], 10)

def test_unknown_eventlog_config(self):
"""
eventlogging - Unknown config parameter
"""
self.render_config_template(
event_logs=[
{
"name": self.providerName,
"api": self.api,
"event_id": "10, 12",
"level": "info",
"provider": ["me"],
"include_xml": True,
}
]
)
self.start_beat().check_wait(exit_code=1)
assert self.log_contains("4 errors: invalid event log key")

def test_utf16_characters(self):
"""
eventlogging - UTF-16 characters
Expand Down
17 changes: 0 additions & 17 deletions winlogbeat/tests/system/test_wineventlog.py
Original file line number Diff line number Diff line change
Expand Up @@ -311,23 +311,6 @@ def test_query_multi_param(self):
self.assertTrue(len(evts), 1)
self.assertEqual(evts[0]["message"], "selected")

def test_unknown_eventlog_config(self):
"""
wineventlog - Unknown config parameter
"""
self.render_config_template(
event_logs=[
{
"name": self.providerName,
"api": self.api,
"forwarded": False,
"invalid": "garbage"}
]
)
self.start_beat().check_wait(exit_code=1)
assert self.log_contains(
"1 error: invalid event log key 'invalid' found.")

def test_utf16_characters(self):
"""
wineventlog - UTF-16 characters
Expand Down