DS-23428 Add DETAIL.md

DETAIL.md

@@ -0,0 +1,49 @@
+Trend Micro Deep Security for Splunk
+=========================
+
+Overview
+--------
+This package contains parsing logic, saved searches, and dashboards for monitoring Trend Micro Deep Security via Splunk.
+
+Please read the Installation section below for details on how to configure Deep Security to use this App.
+
+![](/screenshots/antimalware_dashboard.png) 
+
+![](/screenshots/ips_dashboard.png)
+
+Installation
+------------
+Install this App through the “Manage Apps” functionality within Splunk. For additional information on installing Splunk Apps please refer to the Splunk documentation.
+
+It is highly recommended that Splunk best practices for syslog are followed and you configure rsyslog or syslog-ng to write syslog output to a file which can then be collected by a Splunk forwarder and sent to the Splunk server. You will want to ensure that the Splunk forwarder sets the sourcetype to "deepsecurity" when forwarding events to a Splunk receiver.
+
+Alternatively, you can setup a UDP syslog listener directly on the Splunk server and configure it to assign the sourcetype "deepsecurity" to all messages received.
+
+Next, you will configure Deep Security to send event data to your chosen collection method.
+
+For System Events, this is configured via Administration -> System Settings -> SIEM.
+For Security Events, this is configured within your security policies in the Settings -> SIEM section.
+
+For additional information, refer to the Deep Security online help or product documentation.
+
+Upgrade from Version 1.4
+------------
+All syslog inputs in the Deep Security for Splunk App that were included in version 1.4 have been removed. If you are upgrading from version 1.4 and were using the individual syslog listening ports, you will need to configure a new syslog input which assigns the sourcetype "deepsecurity". This can be a single UDP syslog port in version 1.5.1 of the app and doesn't need to be individual ports as it was in version 1.4.
+
+This change will help make the app compatibles with both Splunk Enterprise and Splunk Cloud.
+
+Usage
+------------
+Deep Security can be configured to send event data in Common Event Format (CEF). This add-on will parse the various syslog message and extract the appropriate fields including the custom key/value pairs.
+
+Example:
+
+CEF:0|Trend Micro|Deep Security Agent|8.0.0.995|1001111|Test Intrusion Prevention Rule|3|cn1=1 cn1Label=Host ID dvchost=hostname dmac=00:50:56:F5:7F:47 smac=00:0C:29:EB:35:DE TrendMicroDsFrameType=IP src=192.168.126.150 dst=72.14.204.105 out=1093 cs3=DF 0 cs3Label=Fragmentation Bits proto=TCP spt=49786 dpt=80 cs2=0x00 ACK PSH cs2Label=TCP Flags cnt=1 act=IDS:Reset cn3=10 cn3Label=Intrusion Prevention Packet Position cs5=10 cs5Label=Intrusion Prevention Stream Position cs6=8 cs6Label=Intrusion Prevention Flags
+
+Using the message above as an example, the add-on will extract the following custom key/value pairs:
+
+Host_ID=1
+Fragmentation Bits=DF
+Intrusion Prevention Packet Position=10
+Intrusion Prevention Stream Position=10
+Intrusion Prevention Flags=8