Sophos module
editSophos module
editThis is a module for Sophos Products, currently it accepts logs in syslog format or from a file for the following devices:
-
xg
fileset: supports Sophos XG SFOS logs. -
utm
fileset: supports Sophos UTM logs.
To configure a remote syslog destination, please reference the SophosXG/SFOS Documentation.
The syslog format choosen in Sophos configuration should be Central Reporting Format
.
Read the quick start to learn how to configure and run modules.
Compatibility
editThis module has been tested against SFOS version 17.5.x, 18.0.x, and 18.5.x. Versions above this and between 18.0 - 18.5 are expected to work but have not been tested.
Configure the module
editYou can further refine the behavior of the sophos
module by specifying
variable settings in the
modules.d/sophos.yml
file, or overriding settings at the command line.
You must enable at least one fileset in the module. Filesets are disabled by default.
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the sophos
module uses
the defaults.
For advanced use cases, you can also override input settings. See Override input settings.
When you specify a setting at the command line, remember to prefix the
setting with the module name, for example, sophos.xg.var.paths
instead of xg.var.paths
.
xg
fileset settings
editThe Sophos XG firewalls do not include hostname in either the syslog header or body, and the only unique identifier for each firewall is the related serial number.
Below you will see an example configuration file, that sets the default hostname (if no serial number is included in the config file), and example on how to map serial numbers to a hostname
- module: sophos xg: enabled: true var.input: udp var.syslog_host: 0.0.0.0 var.syslog_port: 9005 var.default_host_name: firewall.localgroup.local var.known_devices: - serial_number: "1234567890123457" hostname: "a.host.local" - serial_number: "1234234590678557" hostname: "b.host.local"
-
var.paths
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system. -
var.input
-
The input to use, can be either the value
tcp
,udp
orfile
. -
var.syslog_host
- The interface to listen to all syslog traffic. Defaults to localhost. Set to 0.0.0.0 to bind to all available interfaces.
-
var.syslog_port
- The port to listen for syslog traffic. Defaults to 9005.
-
var.host_name
-
Host name / Observer name, since SophosXG does not provide this in the syslog file.
Default to
firewall.localgroup.local
SophosXG ECS fields
editThis is a list of SophosXG fields that are mapped to ECS.
SophosXG Fields | ECS Fields | |
---|---|---|
application |
network.protocol |
|
classification |
rule.category |
|
device_id |
observer.serial_number |
|
domainname |
url.domain |
|
dst_host |
destination.address |
|
dst_int |
observer.egress.interface.name |
|
dstzonetype |
observer.egress.zone |
|
dst_ip |
destination.ip |
|
destinationip |
destination.ip |
|
dst_mac |
destination.mac |
|
dstname |
destination.address |
|
dst_port |
destination.port |
|
dst_domainname |
url.domain |
|
duration |
event.duration |
|
filename |
file.name |
|
filetype |
file.extension |
|
file_size |
file.size |
|
file_path |
file.directory |
|
fw_rule_id |
rule.id |
|
from_email_address |
source.user.email |
|
httpstatus |
http.response.status_code |
|
in_interface |
observer.ingress.interface.name |
|
log_id |
event.code |
|
log_subtype |
event.action |
|
message |
message |
|
method |
http.request.method |
|
policy_type |
rule.ruleset |
|
protocol |
network.transport |
|
recv_bytes |
destination.bytes |
|
recv_pkts |
destination.packets |
|
referer |
http.request.referrer |
|
sent_bytes |
source.bytes |
|
sent_pkts |
source.packets |
|
sha1sum |
file.hash.sha1 |
|
srczonetype |
observer.ingress.zone |
|
src_ip |
source.ip |
|
src_domainname |
url.domain |
|
sourceip |
source.ip |
|
src_mac |
source.mac |
|
src_port |
source.port |
|
status_code |
http.response.status_code |
|
time_zone |
event.timezone |
|
to_email_address |
destination.user.email |
|
tran_dst_ip |
destination.nat.ip |
|
tran_dst_port |
destination.nat.port |
|
tran_src_ip |
source.nat.ip |
|
tran_src_port |
source.nat.port |
|
url |
url.original |
|
user_agent |
user_agent.original |
|
useragent |
user_agent.original |
|
user_gp |
source.user.group |
|
user_name |
source.user.name |
|
ws_protocol |
http.version |
utm
fileset settings
editThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This was converted from RSA NetWitness log parser XML "astarosg" device revision 123.
-
var.input
-
The input from which messages are read. One of
file
,tcp
orudp
. Defaults toudp
. -
var.syslog_host
-
The address to listen to UDP or TCP based syslog traffic.
Defaults to
localhost
. Set to0.0.0.0
to bind to all available interfaces. -
var.syslog_port
-
The port to listen for syslog traffic. Defaults to
9533
Ports below 1024 require Filebeat to run as root.
-
var.tz_offset
-
By default, datetimes in the logs will be interpreted as relative to
the timezone configured in the host where Filebeat is running. If ingesting
logs from a host on a different timezone, use this field to set the timezone
offset so that datetimes are correctly parsed. Valid values are in the form
±HH:mm, for example,
-07:00
forUTC-7
. -
var.rsa_fields
-
Flag to control the addition of non-ECS fields to the event. Defaults to true,
which causes both ECS and custom fields under
rsa
to be added. -
var.keep_raw_fields
-
Flag to control the addition of the raw parser fields to the event. This fields
will be found under
rsa.raw
. The default is false.
Fields
editFor a description of each field in the module, see the exported fields section.