Cherry-pick #22999 to 7.x: [Winlogbeat] Add subdomain value for sysmo…

…n module (#23008) * [Winlogbeat] Add subdomain value for sysmon module (#22999) * [Winlogbeat] Add subdomain value for sysmon module * Add changelog entry * Add target_subdomain_field to docs example (cherry picked from commit d38a5d0) * Fix up changelog
elastic · Dec 9, 2020 · 171a849 · 171a849
1 parent 385f9e3
commit 171a849
Show file tree

Hide file tree

Showing 7 changed files with 349 additions and 171 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -586,6 +586,7 @@ port. {pull}19209[19209]
 - Add support for event IDs 4673,4674,4697,4698,4699,4700,4701,4702,4768,4769,4770,4771,4776,4778,4779,4964 to the Security module {pull}17517[17517]
 - Add registry and code signature information and ECS categorization fields for sysmon module {pull}18058[18058]
 - Add file.pe and process.pe fields to ProcessCreate & LoadImage events in Sysmon module. {issue}17335[17335] {pull}22217[22217]
+- Add dns.question.subdomain fields for sysmon DNS events. {pull}22999[22999]
 
 *Elastic Log Driver*
 

diff --git a/libbeat/processors/registered_domain/config.go b/libbeat/processors/registered_domain/config.go
@@ -18,11 +18,12 @@
 package registered_domain
 
 type config struct {
-	Field         string `config:"field"        validate:"required"`
-	TargetField   string `config:"target_field" validate:"required"`
-	IgnoreMissing bool   `config:"ignore_missing"`
-	IgnoreFailure bool   `config:"ignore_failure"`
-	ID            string `config:"id"`
+	Field                string `config:"field"        validate:"required"`
+	TargetField          string `config:"target_field" validate:"required"`
+	TargetSubdomainField string `config:"target_subdomain_field"`
+	IgnoreMissing        bool   `config:"ignore_missing"`
+	IgnoreFailure        bool   `config:"ignore_failure"`
+	ID                   string `config:"id"`
 }
 
 func defaultConfig() config {

diff --git a/libbeat/processors/registered_domain/docs/registered_domain.asciidoc b/libbeat/processors/registered_domain/docs/registered_domain.asciidoc
@@ -9,7 +9,8 @@ The `registered_domain` processor reads a field containing a hostname and then
 writes the "registered domain" contained in the hostname to the target field.
 For example, given `www.google.co.uk` the processor would output `google.co.uk`.
 In other words the "registered domain" is the effective top-level domain
-(`co.uk`) plus one level (`google`).
+(`co.uk`) plus one level (`google`). Optionally, it can store the rest of the
+domain, the `subdomain` into another target field.
 
 This processor uses the Mozilla Public Suffix list to determine the value.
 
@@ -19,6 +20,7 @@ processors:
   - registered_domain:
       field: dns.question.name
       target_field: dns.question.registered_domain
+      target_subdomain_field: dns.question.sudomain
       ignore_missing: true
       ignore_failure: true
 ----
@@ -28,10 +30,11 @@ The `registered_domain` processor has the following configuration settings:
 .Registered Domain options
 [options="header"]
 |======
-| Name             | Required | Default    | Description                                                      |
-| `field`          | yes      |            | Source field containing a fully qualified domain name (FQDN).    |
-| `target_field`   | yes      |            | Target field for the registered domain value.                    |
-| `ignore_missing` | no       | false      | Ignore errors when the source field is missing.                  |
-| `ignore_failure` | no       | false      | Ignore all errors produced by the processor.                     |
-| `id`             | no       |            | An identifier for this processor instance. Useful for debugging. |
+| Name                     | Required | Default    | Description                                                      |
+| `field`                  | yes      |            | Source field containing a fully qualified domain name (FQDN).    |
+| `target_field`           | yes      |            | Target field for the registered domain value.                    |
+| `target_subdomain_field` | no       |            | Target subdomain field for the subdomain value.                  |
+| `ignore_missing`         | no       | false      | Ignore errors when the source field is missing.                  |
+| `ignore_failure`         | no       | false      | Ignore all errors produced by the processor.                     |
+| `id`                     | no       |            | An identifier for this processor instance. Useful for debugging. |
 |======
diff --git a/libbeat/processors/registered_domain/registered_domain.go b/libbeat/processors/registered_domain/registered_domain.go
@@ -19,6 +19,7 @@ package registered_domain
 
 import (
 	"encoding/json"
+	"strings"
 
 	"github.com/pkg/errors"
 	"golang.org/x/net/publicsuffix"
@@ -105,5 +106,18 @@ func (p *processor) Run(event *beat.Event) (*beat.Event, error) {
 		return event, errors.Wrapf(err, "failed to write registered domain to target field [%v]", p.TargetField)
 	}
 
+	if p.TargetSubdomainField != "" {
+		subdomain := strings.TrimSuffix(strings.TrimSuffix(domain, rd), ".")
+		if subdomain != "" {
+			_, err = event.PutValue(p.TargetSubdomainField, subdomain)
+			if err != nil {
+				if p.IgnoreFailure {
+					return event, nil
+				}
+				return event, errors.Wrapf(err, "failed to write subdomain to target field [%v]", p.TargetSubdomainField)
+			}
+		}
+	}
+
 	return event, nil
 }
diff --git a/libbeat/processors/registered_domain/registered_domain_test.go b/libbeat/processors/registered_domain/registered_domain_test.go
@@ -31,22 +31,25 @@ func TestProcessorRun(t *testing.T) {
 		Error            bool
 		Domain           string
 		RegisteredDomain string
+		Subdomain        string
 	}{
-		{false, "www.google.com", "google.com"},
-		{false, "www.google.co.uk", "google.co.uk"},
-		{false, "google.com", "google.com"},
-		{false, "www.ak.local", "ak.local"},
-		{false, "www.navy.mil", "navy.mil"},
+		{false, "www.google.com", "google.com", "www"},
+		{false, "www.google.co.uk", "google.co.uk", "www"},
+		{false, "www.mail.google.co.uk", "google.co.uk", "www.mail"},
+		{false, "google.com", "google.com", ""},
+		{false, "www.ak.local", "ak.local", "www"},
+		{false, "www.navy.mil", "navy.mil", "www"},
 
-		{true, "com", ""},
-		{true, ".", "."},
-		{true, "", ""},
-		{true, "localhost", ""},
+		{true, "com", "", ""},
+		{true, ".", ".", ""},
+		{true, "", "", ""},
+		{true, "localhost", "", ""},
 	}
 
 	c := defaultConfig()
 	c.Field = "domain"
 	c.TargetField = "registered_domain"
+	c.TargetSubdomainField = "subdomain"
 	p, err := newRegisteredDomain(c)
 	if err != nil {
 		t.Fatal(err)
@@ -71,5 +74,10 @@ func TestProcessorRun(t *testing.T) {
 
 		rd, _ := evt.GetValue("registered_domain")
 		assert.Equal(t, tc.RegisteredDomain, rd)
+
+		if tc.Subdomain != "" {
+			subdomain, _ := evt.GetValue("subdomain")
+			assert.Equal(t, tc.Subdomain, subdomain)
+		}
 	}
 }
diff --git a/x-pack/winlogbeat/module/sysmon/config/winlogbeat-sysmon.js b/x-pack/winlogbeat/module/sysmon/config/winlogbeat-sysmon.js
@@ -1538,6 +1538,7 @@ var sysmon = (function () {
             ignore_missing: true,
             field: "dns.question.name",
             target_field: "dns.question.registered_domain",
+            target_subdomain_field: "dns.question.subdomain",
         })
         .Add(setRuleName)
         .Add(translateDnsQueryStatus)