B Leef Format Guide
B Leef Format Guide
IBM
Note
Before using this information and the product that it supports, read the information in Notices on page 13.
Product information
This document applies to IBM Security QRadar Security Intelligence Platform V7.2.5 and subsequent releases unless
superseded by an updated version of this document.
Copyright IBM Corporation 2013, 2016.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Introduction to QRadar LEEF . . . . . . . . . . . . . . . . . . . . . . . . . . v
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Privacy policy considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Intended audience
This guide is intended for all QRadar users who are responsible for investigating
and managing network security. To use this information, you must have access to
QRadar products and a knowledge of your corporate network and networking
technologies.
Technical documentation
To find IBM Security QRadar product documentation on the web, including all
translated documentation, access the IBM Knowledge Center (http://
www.ibm.com/support/knowledgecenter/SS42VS/welcome).
For information about how to access more technical documentation in the QRadar
products library, see Accessing IBM Security Documentation Technical Note
(www.ibm.com/support/docview.wss?rs=0&uid=swg21614644).
For information about contacting customer support, see the Support and
Download Technical Note (http://www.ibm.com/support/docview.wss?rs=0
&uid=swg21612861).
Please Note:
Use of this Program may implicate various laws or regulations, including those
related to privacy, data protection, employment, and electronic communications
and storage. IBM Security QRadar may be used only for lawful purposes and in a
lawful manner. Customer agrees to use this Program pursuant to, and assumes all
responsibility for complying with, applicable laws, regulations and policies.
QRadar can integrate, identify, and process LEEF events. LEEF events must use
UTF-8 character encoding.
You can send events in LEEF output to QRadar by using the following protocols:
v Syslog
v File import with the Log File Protocol
Important: Before QRadar can use LEEF events, you must complete Universal
LEEF configuration tasks. For more information about configuring the log file
protocol to collect Universal LEEF events, see the IBM Security QRadar DSM
Configuration Guide.
The method that you select to provide LEEF events determines whether the events
can be automatically discovered in QRadar. When events are automatically
discovered the level of manual configuration that is needed in QRadar is reduced.
As LEEF events are received, QRadar analyzes the event traffic in an attempt to
identify the device or appliance. This process is referred to as traffic analysis. It
typically takes at least 25 LEEF events to identify and create a new log source in
QRadar. Until traffic analysis identifies the event source, the initial 25 events are
categorized as SIM Generic Log DSM events and the event name is set as Unknown
Log Event. After the event traffic is identified, QRadar creates a log source to
properly categorize and label any events that are forwarded from your appliance
or software. Events that are sent from your device are viewable in QRadar on the
Log Activity tab.
Important: When a log source cannot be identified after 1,000 events, QRadar
creates a system notification and removes the log source from the traffic analysis
queue. QRadar is still capable of collecting the events, but a user must intervene
and create a log source manually to identify the event type.
Syslog header
The syslog header is an optional field. The syslog header contains the timestamp
and IPv4 address or host name of the system that is providing the event. The
syslog header is an optional component of the LEEF format. If you include the
syslog header, you must separate the syslog header from the LEEF header with a
space.
LEEF header
The LEEF header is a required field for LEEF events. The LEEF header is a pipe
delimited (|) set of values that identifies your software or appliance to QRadar.
Examples:
v LEEF:Version|Vendor|Product|Version|EventID|
v LEEF:1.0|Microsoft|MSExchange|4.0 SP1|15345|
v LEEF:2.0|Lancope|StealthWatch|1.0|41|^|
Event attributes
The event attributes identify the payload information of the event that is produced
by your appliance or software. Every event attribute is a key and value pair with a
tab that separates individual payload events. The LEEF format contains a number
of predefined event attributes, which allow QRadar to categorize and display the
event.
Example:
v key=value<tab>key=value<tab>key=value<tab>key=value<tab>.
v src=7.5.6.6 dst=172.50.123.1 sev=5 cat=anomaly srcPort=81 dstPort=21
usrName=joe.black
192.168.1.1
myhostname
For example,
LEEF:1.0|Vendor|Product|Version|EventID|
LEEF Header Vendor or Pipe Vendor is a text string that identifies the vendor or
manufacturer manufacturer of the device that sends the syslog
name events in LEEF format.
For example,
LEEF:1.0|Microsoft|Product|Version|EventID|
For example,
LEEF:1.0|Microsoft|MSExchange|Version|EventID|
Examples:
v LEEF:1.0|Microsoft|MSExchange|2007|7732|
v LEEF:1.0|Microsoft|MSExchange|2007|Logon
Failure|
Restrictions:
LEEF uses a specific list of name-value pairs that are predefined LEEF event
attributes. These keys outline fields that are identifiable to IBM Security QRadar.
Use these keys on your appliance when possible, but your event payloads are not
limited by this list. LEEF is extensible and you can add more keys to the event
payload for your appliance or application.
Cat and the EventID field in the LEEF header help map your
appliance event to a QRadar Identifier (QID) map entry. The
EventID represents the first column and the category
represents the second column of the QID map.
Restriction: The value of the event category must be
consistent and static across products that support multiple
languages. If your product supports multi-language events,
you can use a numeric or textual value in the cat field, but it
must not be translated when the language of your appliance or
application is altered.
String Yes
cat (continued) Example 1: Use the cat key to extend the EventID with
additional information to describe the event. If the EventID is
defined as a User Login event, use the category to further
categorize the event, such as a success or failed login. You can
define your EventIDs further with the cat key, and the extra
detail from the event can be used to distinguish between
events when the same EventID is used for similar event types,
for example,
LEEF:1.0|Microsoft|Exchange|2013|Login Event|cat=Failed
LEEF:1.0|Microsoft|Exchange|2013|Login Event|cat=Success
LEEF:1.0|Microsoft|Endpoint|2015|
Conficker_worm|cat=Detected
devTime Date Yes
The raw event date and time that is generated by your
appliance or application that provides the LEEF event.
http://www.iana.org/assignments/protocol-numbers/
protocol-numbers.xml
sev Integer Yes
Indicates the severity of the event.
11:2D:67:BF:1A:71
dstMAC MAC Yes
Address The MAC address of the event destination in hexadecimal. The
MAC address is composed of six groups of two hexadecimal
digits, which are colon-separated, for example,
11:2D:67:BF:1A:71
srcPreNATPort Integer Yes
The port number of the event source before Network Address
Translation (NAT).
identHostName
identNetBios
identGrpName
identMAC
identHostName String Key
Host name information that is associated with the identSrc to
further identify the true host name that is tied to an event.
isLoginEvent=true
isLoginEvent=false
isLogoutEvent=true
isLogoutEvent=false
Attribute Limits: 2
calCountryOrRegion String No
Extends the calLanguage key to provide more translation
information that can include the country or region for the
event device time (devTime). The key calCountryOrRegion must
be used with the calLanguage key.
Attribute Limits: 2
Note: Event attribute keys and values can appear one time only in each payload.
Using a key-value pair twice in the same payload can cause IBM Security QRadar
to ignore the value of the duplicate key.
Custom event keys are non-normalized, which means that any specialized key value
pairs you include in your LEEF event are not displayed by default on the Log
Activity tab of QRadar. To view custom attributes and non-normalized events on the
Log Activity tab of QRadar, you must create a custom event property.
Non-normalized event data is still part of your LEEF event, is searchable in QRadar,
and is viewable in the event payload. For more information about creating a
custom event property, see the IBM Security QRadar Administration Guide.
Items that are marked Allowed can be included in a key or value, and is not in
violation of LEEF but these items are not good practice when you create custom
event keys.
The following list contains custom key and value general guidelines:
v Use alphanumeric (A-Z, a-z, and 0-9) characters, but avoid tab, pipe, or caret
delimiters in your event payload keys and values (key=value).
Correct - usrName=Joe.Smith
Incorrect - usrName=Joe<tab>Smith
v Contain a single word for the key attribute (key=value).
Correct - file name=pic07720.gif
Allowed - file name=pic07720.gif
Allowed - file name =pic07720.gif
v A user-defined key cannot use the same name as a LEEF predefined key. For
more information, see Predefined LEEF event attributes on page 4.
v Key values must be human readable, if possible, to help you to investigate event
payloads.
Correct - deviceProcessHash=value
Correct - malwarename=value
Allowed - EBFDFBE14D4=value
Use the devTimeformat to format the devTime event attribute to display the event in
IBM Security QRadar. The suggested devTimeFormat patterns are listed in the
following table:
For more information about specifying a date format, see the SimpleDateFormat
information on the Java Web Page(http://docs.oracle.com/javase/7/docs/api/
java/text/SimpleDateFormat.html).
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
170 Tracer Lane,
Waltham MA 02451, USA
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Depending upon the configurations deployed, this Software Offering may use
session cookies that collect each users session id for purposes of session
management and authentication. These cookies can be disabled, but disabling them
will also eliminate the functionality they enable.
If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.
For more information about the use of various technologies, including cookies, for
these purposes, See IBMs Privacy Policy at http://www.ibm.com/privacy and
IBMs Online Privacy Statement at http://www.ibm.com/privacy/details the
section entitled Cookies, Web Beacons and Other Technologies and the IBM
Software Products and Software-as-a-Service Privacy Statement at
http://www.ibm.com/software/info/product-privacy.
Notices 15
16 Log Event Extended Format (LEEF)
IBM
Printed in USA