background image

Release 2008.2

J

UNIPER

 N

ETWORKS

 STRM 

T

ECHNICAL

 N

OTE

U

SING

 E

XTENSION

 D

OCUMENTS

J

UNE

 2008

Device extensions allow you to modify how a DSM parses logs, which is useful for 
resolving parsing issues. However, before you define a device extension, you must 
build an extension document. This document provides information on defining an 
extension document including: 

About Extension Documents

 

Understanding Extension Document Elements

 

Creating Extension Documents

 

Device Type IDs

 

 This document assumes an advanced knowledge of XML coding. 

About Extension 
Documents

The extension document is specified in Extensible Markup Language (XML) 
format. You can create and edit the document using any common word processing 
application.  You can create multiple extension documents and associate an 
extension document to various device types. Using an extension document, you 
can resolve parsing issues, such as: 

Fixing an event that has missing or incorrect fields (for example, if the 
username is not being parsed). 

Completing the parsing of an event when the DSM to which it is attached fails to 
produce a result. Any new events produced by the device extension are 
associated to the device that failed to parse the original payload. This action 
prevents these events from appearing as un-parsed in the STRM interface.

XML format allows for a simplification of the extension document’s organization, 
and verifies the extension document’s contents. Using this format requires that all 
regular expressions be contained in character data (CDATA) sections to prevent 
the special characters that are needed by regular expressions from interfering with 
the markup format. For example: 

<pattern id="Protocol" case-insensitive="true" xmlns="">

 

<![CDATA[(tcp|udp|icmp|gre)]]></pattern>

Where 

(tcp|udp|icmp|gre)

 is the actual regular expression pattern. 

Summary of Contents for NETWORKS STRM - TECHNICAL NOTE REV 6-2008

Page 1: ...to various device types Using an extension document you can resolve parsing issues such as Fixing an event that has missing or incorrect fields for example if the username is not being parsed Completi...

Page 2: ...ch groups may appear in the extension document Table 1 Pattern Parameters Parameter Description id Required Specify a regular string that is unique within the extension document case insensitive Optio...

Page 3: ...st be a valid device type ID represented as an integer A list of device type IDs is presented in Table 6 If not specified this parameter defaults to the device type of the device to which the extensio...

Page 4: ...nted with a straight group capture You can combine multiple groups together with extra text to form a value This parameter enables that behavior This parameter changes the meaning of the capture group...

Page 5: ...ource MAC address for the message SourcePortPreNAT Specify the source port for the message before NAT occurs SourcePortPostNAT Specify the source port for the message after NAT occurs DestinationIp Sp...

Page 6: ...port based protocols UserName Specify the user name associated with the event HostName Specify the host name associated with the event This field is usually only associated with identity events GroupN...

Page 7: ...ation on creating extension documents including Writing a Complete Extension Document Uploading Extension Documents Solving Specific Parsing Issues send identity Specifies the sending of identity chan...

Page 8: ...ld could use the exact same pattern in this case this may not be true in all FWSM events xml version 1 0 encoding UTF 8 device extension xmlns event_parsing device_extension pattern id EventNameFWSM x...

Page 9: ...l The FWSM uses the Cisco Pix QID and therefore includes the device type id override 6 parameter in the match group the Pix firewall s device type ID is 6 see Table 6 If the QID information is not spe...

Page 10: ...ce of TCP UDP ICMP or GRE the pattern is marked with the case insensitive parameter so that any occurrence matches Note You must search for the protocol when writing extension documents as STRM may no...

Page 11: ...The following is an example of a straight substitution that parses the source IP address and then overrides the result and sets the IP address to 10 100 100 100 ignoring the IP address in the payload...

Page 12: ...llowing example is similar to the above single event example except that this example matches all event codes starting with 7 and followed by one to five digits pattern id EventNameId xmlns CDATA 7 d...

Page 13: ...x login messages 12 WindowsAuthServer Windows Security Event Log 13 IIS Windows IIS Webserver logs 14 Iptables Linux iptables Firewall 15 Proventia ISS Proventia Device 16 Classify Q1Labs Classify Eng...

Page 14: ...niper Infranet Controller 60 PDSN Sprint PoC PDSN 61 RNC Sprint PoC RNC 62 BTS Sprint PoC BTS 63 ACS Cisco ACS 64 JuniperRouter Juniper Router 65 Sprint Sprint PoC 66 CallManager Cisco Call Manager 67...

Page 15: ...Nortel Switched Firewall 6000 105 Q1Labs QRadar Q1Labs QRadar 106 3Com 8800 Series Switch 3Com 8800 Series Switch 107 Nortel VPN Gateway Nortel VPN Gateway 108 NortelTPS Nortel Threat Protection Intru...

Page 16: ...trademarks or registered service marks in this document are the property of Juniper Networks or their respective owners All specifications are subject to change without notice Juniper Networks assumes...

Reviews: