SmartConnector UserGuide
SmartConnector UserGuide
ArcSight Connectors
Legal Notices
Warranty
The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are set forth in
the express warranty statements accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained
herein. The information contained herein is subject to change without notice.
Copyright Notice
© Copyright 2000-2018 Micro Focus or one of its affiliates.
Trademark Notices
Adobe™ is a trademark of Adobe Systems Incorporated.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
Support
Contact Information
Phone A list of phone numbers is available on the Technical Support
Page: https://softwaresupport.softwaregrp.com/support-contact-information
Document Changes
Date Product Version Description
Note: The device versions currently documented in individual SmartConnector configuration guides
are versions that have been tested by ArcSight Quality Assurance. These are generally referred to
as versions certified. For minor device versions that fall in between certified versions, it has been our
experience that vendors typically do not make major changes to the event generation mechanism in
minor versions; therefore, we consider these versions to be supported. Minor adjustments can be
accommodated by parser overrides as needed. For example, Extreme Networks Dragon Export Tool
versions 7.4 and 8.0 have been certified; Dragon Export Tool version 7.5 is considered to be
supported.
In brief, connectors:
l Collect all the data you need from a source device, eliminating the need to return to the device during
an investigation or audit.
l Parse individual events and normalize event values (such as severity, priority and time zone) into a
common schema (format) for use by the ESM Manager.
l Filter out data you know is not needed for analysis, thus saving network bandwidth and storage
space (optional).
l Aggregate events to reduce the quantity of events sent to the ESM Manager, increasing ArcSight’s
efficiency and reducing event processing time (optional).
l Categorize events using a common, human-readable format, saving you time and making it easier to
use those event categories to build filters, rules, reports, and data monitors.
l Pass processed events to the ESM Manager.
Depending upon the network device, some connectors can issue commands to devices. These actions
can be executed manually or through automated actions from rules and some data monitors.
Once connectors normalize and send events to the ESM Manager, the events are stored in the
centralized ESM database. ESM then filters and cross-correlates these events with rules to generate
meta-events. The meta-events then are automatically sent to administrators with corresponding
Knowledge Base articles that contain information supporting their enterprise’s policies and procedures.
Connectors process raw data generated by various vendor devices throughout an enterprise. Devices
consist of routers, e-mail servers, anti-virus products, fire walls, intrusion detection systems (IDS), access
control servers, VPN systems, anti-DoS appliances, operating system logs, and other sources that detect
and report security or audit information.
Connectors collect a large amount of varying, heterogeneous information. Due to this variety of
information, connectors format each event into a consistent, normalized ArcSight message, letting you
find, sort, compare, and analyze all events using the same event fields.
Specific connector configuration guides document device-to-ESM event mapping information for
individual vendor devices, as well as specific installation parameters and configuration information.
The following table lists destination settings that can be modified. These are functions that the
connector performs on events. For details about how the following features work see Configuring
Destination Settings.
Feature Description
Filtering and Uses AND/OR based Boolean logic to determine what data is to be included from the device and what
Data data is filtered out when the event is sent to the destination.
Reduction
Aggregation Compiles events with matching values into a single event, reducing the number of individual events
the destination must evaluate.
Batching Improves the destination performance by sending a collection of events at one time (rather than after
each occurrence).
Time Error Synchronizes the time between the device and the connector, and between the connector and the
Correction destination.
Time Zone Corrects the local time zone, as necessary, to support device-time queries, correlation, and filters.
Correction
Resolver Attempts to resolve and reverse-resolve host names and addresses reported by a device.
Data Converts each event produced by devices to a destination common event format message (or ArcSight
Normalization message).
Logfu A command that analyzes log files for troubleshooting problems by generating an HTML report
Command (logfu.html ) and including a graphical view of time-based log data. Logfu pinpoints the time of the
problem and often the cause.
If using PuTTY, you also need an X11 client on the machine from which you are connecting to the Linux
machine.
Tip: You can deploy connectors on a device, on a separate host machine, or on the host machine
where the destination system resides.
Connectors both receive and retrieve information from network devices. If the device sends
information, the connector becomes a receiver; if the device does not send information, the connector
retrieves it.
Once an event is received by the connector, it adds device and event information to the event to
complete the message, which is then sent to the configured destination.
Data Encryption
To follow new regulatory requirements that mandate that data leaving the connector machine to
another destination be encrypted, you can use SecureData format preserving encryption.
When installing and configuring a connector, you can choose to enable this encryption. You will provide
the URL of the encryption server, the identity and shared secret configured for SecureData, and the
fields to be encrypted when configuring the connector. For optimum performance, the number of
encrypted fields should be limited to 20 fields. If a proxy is enabled for the machine, a proxy host and
port for http connection are also required.
See the SmartConnector Configuration Guide for the specific connector you are installing for a
description of the format preserving parameters.
Notes:
l Once encryption is enabled, you cannot change any of the encryption parameters. To do so
requires a new installation of the connector. If you install a connector without enabled
encryption but want to do so later, you can Modify Connector Parameters through the wizard,
enable encryption, and provide the encryption parameters.
l In deployments where multiple connectors are chained or cascaded before reaching the
destination, the encryption should only be enabled at the very first connector.
l Encryption of address fields in the event is not supported. This includes IP addresses and MAC
addresses.
l The input data must be at least three characters long to be encrypted if the data is all digits.
l This feature is supported only on Linux and Windows 64-bit platforms.
l Additional data fields cannot be selected for encryption.
l Although the connector and the destination can be set to FIPS-compliant mode for event data
transfer between the connector and the destination configured, if encryption is enabled, the
communication between the connector and secure server is not FIPS-compliant.
l Derived event fields cannot be chosen for encryption. If any of the derived fields need
encryption, include the parent field for encryption.
For mappings for a certified CEF vendor's connector, see their product documentation, available from
the Micro Focus Enterprise Security Technology Alliances site on Protect 724 at
https://community.softwaregrp.com/t5/Security-Technology-Alliances/ct-p/technology-alliances.
Connector Types
Connectors are the interface between the ESM Manager and the network devices that generate ESM-
relevant data on your network.
Connectors are generally one of the following types:
l API Connectors
l Database Connectors
l FlexConnectors
l File Connectors
File Connectors
There are two primary types of log file connector, Real Time and Folder Follower:
Real Time
These connectors can continue to follow a log file that retains its name or changes its name based upon
the current date and other factors. The type of real time file connector is based upon the number of files
monitored by the connector. There are connectors that monitor a single log file and connectors that
monitor multiple log files.
Real Time log file connectors can read normal log files in which lines are separated by a new line
character as well as fixed length records in which a file consists of only one line but multiple records of
fixed length.
Folder Follower
Folder follower connectors can monitor files copied to a folder. There are connectors that monitor a
single log file in a folder and connectors that monitor log files recursively.
.txt and .xml file types are supported by connectors; which type depends upon the particular
device. Most of the scanner file connectors, such as Nessus, and NeXpose, are in XML format.
The type of log file connector is not usually part of the connector name unless both types of connector
exist for a particular device.
File connectors are normally installed on the device machine, but when the monitored files are accessible
through network shares or NFS mounts, the connectors can be installed on remote machines.
For some connectors, a trigger file is required to tell the connector when the file is complete and ready
for processing. Typically, this is the same file name with a different extension. Files are renamed by
default to increments such as .processed, .processed.1, and so on.
Generally, the only parameter required at installation is the location of the log file or files (the absolute
path). When default file paths are known, they are displayed in the installation wizard.
Note: To rename or delete log files, file folders require permissions for the connector.
Database Connectors
Database connectors use SQL queries to periodically poll for events. Connectors support major
database types, including MS SQL, MS Access, MySQL, Oracle, DB2, Postgres, and Sybase.
During installation, the installation wizard asks, at a minimum, the following parameter values:
l JDBC Driver
l JDBC Database URL
l Database User
l Database Password
The database user must have adequate permission to access and read the database. For Audit database
connectors, such as SQL Server Audit DB and Oracle Audit DB, system administrator permission is
required.
In addition to connectors supporting event collection from a single database, some database
connectors support multiple database events such as the Microsoft SQL Server Multiple Instance DB
connector. Others collect events from scanner databases, such as the connector for McAfee
Vulnerability Manager DB.
There are three major types of database connector:
Time-Based
Queries use a time field to retrieve events found since the most recent query time until the current time.
ID-Based
Queries use a numerically increasing ID field to retrieve events from the last checked ID until the
maximum ID.
Job ID-Based
Queries use Job IDs that are not required to increase numerically. Processed Job IDs are filed in such a
way that only new Job IDs are added. Unlike the other two types of database connector, Job IDs can
run in either Interactive mode or Automatic mode.
API Connectors
API connectors use a standard or proprietary API to pull events from devices. In most cases, a certificate
must be imported from the device to authenticate connector access to the device. There are also a
SNMP Connectors
SNMP Traps contain variable bindings, each of which holds a different piece of information for the
event. They are usually sent over UDP to port 162, although the port can be changed.
SNMP connectors listen on port 162 (or any other configured port) and process the received traps.
They can process traps only from one device with a unique Enterprise OID, but can receive multiple trap
types from this device.
SNMP is based upon UDP, so there is a slight chance of events being lost over the network.
Although there are still some SNMP connectors for individual connectors, most SNMP support is
provided by the SmartConnector for SNMP Unified. Parsers use the knowledge of the MIB to map the
event fields, but, unlike some other SNMP-based applications, the connector itself does not require the
MIB to be loaded.
For details about the Unified connector, see the configuration guide for the SmartConnector for
Microsoft Windows Event Log – Unified. For mappings, see the document SmartConnector for
Microsoft Windows Event Log – Unified Windows 2008/2012 Security Event Mappings. For details
about the Native connector, see the configuration guide for the SmartConnector for Microsoft
Windows Event Log -- Native. For mappings, see the document SmartConnector for Microsoft
Windows Event Log - Native Windows Security Event Mappings.
These connectors provide support for partial event parsing based upon the Windows event header for
all System and Application events. Support for a FlexConnector-like framework that lets users create
and deploy their own parsers for parsing the event description for all System and Application events is
also provided.
Some individual Windows Event Log applications are supported by the connectors for Microsoft
Windows Event Log, Microsoft Windows Event Log – Unified and Microsoft Windows Event Log –
Native connectors, for which Windows Event Log application or system support has been developed.
See the configuration guides for these connector for a list of application and system events supported.
Syslog Connectors
Syslog messages are free-form log messages prefixed with a syslog header consisting of a numerical
code (facility + severity), timestamp, and host name. They can be installed as a syslog daemon, pipe, or
file connector. Unlike other file connectors, a syslog connector can receive and process events from
multiple devices. There is a unique regular expression that identifies the device.
l Syslog Daemon connectors listen for syslog messages on a configurable port, using port 514 as a
default. The default protocol is UDP, but other protocols such as Raw TCP are also supported. It is
the only syslog option supported for Windows platforms.
l Syslog Pipe connectors require syslog configuration to send messages with a certain syslog facility
and severity.
The Solaris platform tends to under perform when using Syslog Pipe connectors. The operating
system requires that the connector (reader) open the connection to the pipe file before the syslog
daemon (writer) writes the messages to it. When using Solaris and running the connector as a non-
root user, using a Syslog Pipe connector is not recommended. It does not include permissions to send
an HUP signal to the syslog daemon.
l Syslog File connectors require syslog configuration to send messages with a certain syslog facility
and severity. For high throughout connectors, Syslog File connectors perform better than Syslog
Pipe connectors because of operating system buffer limitations on pipe transmissions.
l Raw Syslog connectors generally do no parsing and takes the syslog string and puts it in the
rawEvent field as-is . The Raw Syslog destination type takes the rawEvent field and sends it as-is
using whichever protocol is chosen (UDP, Raw TCP, or TLS). The Raw Syslog connector is always
used with the Raw Syslog destination. The event flow is streamlined to eliminate components that do
not add value (for example, with the Raw Syslog transport the category fields in the event are
ignored, so the categorization components are skipped). If you are transporting data to ArcSight
Logger, you can use specific configuration parameters to provide minimal normalization of the syslog
data (for source and timestamp).
l Syslog NG Daemon connectors support Syslog NG version 3.0 for BSD syslog format. Support is
provided for collection of IETF standard events. This connector is capable of receiving events over a
secure (encrypted) TLS channel from another connector (whose destination is configured as CEF
Syslog over TLS), and can also receive events from devices.
l CEF Encrypted Syslog (UDP) connectors allow connector-to-connector communication through an
encrypted channel by decrypting events previously encrypted through the CEF Encrypted Syslog
(UDP) destination. The CEF connector lets ESM connect to, aggregate, filter, correlate, and analyze
events from applications and devices that deliver their logs in the CEF standard, using the syslog
transport protocol.
UNIX supports all types of syslog connector. If a syslog process is already running, you can end the
process or run the connector on a different port.
Because UDP is not a reliable protocol, there is a slight chance of missing syslog messages over the
network. Generally, TCP is a supported protocol for syslog connectors.
There is a basic syslog connector, the connector for UNIX OS Syslog, which provides the base parser for
all syslog sub-connectors.
For syslog connector deployment information, see the connector Configuration Guide for UNIX OS
Syslog. For device-specific configuration information and field mappings, see the connector
configuration guide for the specific device. Each syslog sub-connector has its own configuration guide.
During connector installation, for all syslog connectors, choose Syslog Daemon, Syslog Pipe, or Syslog
File. The names of the syslog sub-connectors are not listed.
Scanner Connectors
There are two types of scanner connector, those whose results are retained within a file, and those
retrieved from a database. Results for XML scanner connectors are retained in a file, making them log
file connectors.
Other scanners deposit their scanned events in a database and are treated as database connectors,
requiring the same installation parameters as database connectors.
Scan reports are converted into base events, which , for ESM destinations, can be viewed on the
Console, and aggregated meta events, which are not shown on the Console. Meta events create assets,
asset categories, open ports, and vulnerabilities on the Console.
Scanner connectors can run in either of two modes, automatic or interactive.
Interactive mode
In Interactive mode, a graphical user interface shows the reports or log files available for import from
the configured log directory. Choose reports to send to the connector by checking the box for Send for
individual log files and clicking Send to ArcSight.
Automatic mode
Automatic mode is designed to be used in conjunction with an automated procedure to periodically run
scans. The procedure, or shell script, should execute the scanner periodically and save a report in .cef
format. At the end of the scan, after the report is saved, an empty file called <reportname>.cef_
ready should be created, which indicates to the connector that the .cef report is ready for importing.
The connector continues to search for .cef_ready files and process the corresponding .cef reports.
The processed reports are renamed to ,<original report file>.cef_processed.
Other than the operating mode, other parameter values required for scanner installation depends upon
whether a file or database connector has been implemented. For file connectors, the absolute path to
and name of the log file is required. For database connectors, see "Database Connectors" on page 15.
FlexConnectors
FlexConnectors let you create custom connectors that can read and parse information from third-party
devices and map that information to the ArcSight event schema. When creating a custom connector,
you define a set of properties (a configuration file) that identify the format of the log file or other
source that is imported into the ESM Manager or Logger.
The FlexConnector framework is a software development kit (SDK) that lets you create a connector
tailored to the devices on your network and their specific event data. For complete information about
FlexConnectors and how to use them, see the FlexConnector Developer's Guide.
Other Connectors
Connectors that Use Multiple Mechanisms
Some connectors use multiple mechanisms. For example, the connector for Oracle Audit Database
monitors both the database tables and audit files.
For a complete list of all connectors supported by the ArcSight Management Center, see its Release
Notes. You can also visit the Community site at https://community.softwaregrp.com/t5/ArcSight/ct-
p/arcsight. ArcSight adds new connectors regularly.
See "Connectors with ArcSight Management Center" on page 63 for further details.
ArcSight Logger
Logger is an event data storage appliance optimized for extremely high event throughout. Logger
stores security events onboard in compressed form, but can always retrieve unmodified events on
demand for forensics-quality litigation data.
Logger can be deployed stand-alone to receive events from syslog messages or log files, or to receive
events in Common Event Format from connectors. Logger can forward events to ESM. Multiple
Loggers work together to support high sustained input rates. Event queries are distributed across a
peer network of Loggers. See "ArcSight Logger SmartMessage (encrypted) Destination" on page 87 for
details on the relationship between connectors and Logger.
Please direct any questions or comments to our ADP product team at [email protected].
Connectors in Event Broker supports ArcSight customers who want to have large-scale distributed
ingestion pipelines with 100% availability, where data from any existing or new source at any scale can
be ingested while maintaining enterprise level robustness.
Event Broker can take messages with raw data collected from any source the ArcSight connector
framework understands and automatically perform the data ingestion processing currently done by
connectors, but deployed and managed at scale as Event Broker processing engines.
Users deploy the Event Broker using the ArcSight Installer and ArcMC to achieve the desired layout.
New topics can be created in ArcMC and designated to process raw data from a particular technology
framework with output into a specific format.
The connector technology in Event Broker performs all processing a connector would normally do:
parser selection, normalization, main flow, destination specific flows, and categorization, as well as
applying network zoning and Agent Name resolution.
For more information, see the ArcSight Event Broker Administrator's Guide and the ArcSight
Management Center Administrator's Guide.
Deployment Overview
ArcSight components install consistently across UNIX, Windows, and Macintosh platforms. Whether a
host is dedicated to the ArcSight Database, Manager, Console, or other component, ESM software is
installed in a directory tree under a single root directory on each host (DBMS and other third-party
software is not necessarily installed under this directory, however.) The path to this root directory is
referred to as $ARCSIGHT_HOME.
In connector documentation, the 'current' directory is specified rather than presumed to be part of the
$ARCSIGHT_HOME location, and the path separator is a backslash (\) (for example, $ARCSIGHT_
HOME\current). This is consistent with connector configuration guide information, and also
underscores the fact that connectors are not installed on the same machine as the remaining ESM
components. Rather, they are typically installed on the same machine as the device whose activity will be
monitored.
The directory structure below $ARCSIGHT_HOME is standardized across components and platforms.
ArcSight software is generally available in the $ARCSIGHT_HOME\current\bin directory. Properties
files, which control the ArcSight configuration, are found in $ARCSIGHT_HOME\config and log files are
written to $ARCSIGHT_HOME\logs.
Connectors collect and process the data generated by various vendor devices throughout your
enterprise. Devices consist of routers, e-mail logs, anti-virus products, fire walls, intrusion prevention
systems (IPS), access control servers, VPN systems, antiDoS appliances, operating system logs, and
other sources where information about security threats are detected and reported.
Connectors collect a vast amount of varying, heterogeneous information. When a connector receives an
event, it completes the message by adding device information, then forwarding the event to various
ArcSight components.
Supported Platforms
For information about supported platforms, see the ArcSight SmartConnector Platform Support
document that is shipped with each connector release. Only differences to the support detailed in that
Deployment Scenarios
You can install connectors on the ESM Manager machine, the machine hosting ArcSight Management
Center, a host machine, or a device. Based upon configuration, connectors also can receive events over
the network using SNMP, HTTP, syslog, proprietary protocols (such as OPSEC), or direct database
connections to the device's repository (such as ODBC or proprietary database connections).
The best deployment scenario for your system depends upon the connector type, your network
architecture, and your operating system.
l Scenarios for syslog deployment are documented in the Connector for
UNIX OS Syslog Configuration Guide.
l Scenarios for deploying Windows Event Log connectors are documented in the configuration guides
for the SmartConnector for Microsoft Windows Event Log Unified and Native and SmartConnector
for Windows Event Log.
compression. Individual connectors can be configured to aggregate events in this manner, reducing
event traffic to the ESM Manager and the storage requirements in the ESM Database.
In a distributed environment with multiple ESM Managers, the event volume metric must consider both
the connector feeds to the ESM Manager and the event forwarding from other ESM Managers.
Mode Description
Faster ESM Manager default. Eliminates all but a core set of event attributes to achieve the best throughout.
(Mode 2) Because the event data is smaller, it requires less storage space and provides the best performance.
Complete Connector default. All event data arriving at the connector, including additional data, is maintained.
(Mode 3)
When a turbo mode is not specified, Mode 3, Complete, is the default. Versions of ESM prior to version
3.0 run in turbo mode Complete.
The ESM Manager uses its own turbo mode setting when processing event data. If a connector is set at
a higher turbo mode than the ESM Manager, it reports more event data than the ESM Manager
requires. The ESM Manager ignores these extra fields.
However, if an ESM Manager is set at a higher turbo mode than the connector, the connector has less
event data to report to the ESM Manager. The ESM Manager maintains fields that remain empty of
event data.
Both situations are normal in real-world scenarios because the ESM Manager configuration must reflect
the requirements of a diverse set of connectors.
Note: If you are using the Linux Red Hat 6.x or later platforms, ensure that you have these libraries
installed before installing a connector:
l X libraries
l glibc
l libXext
l libXrender
l libXtst
When installing the 32-bit SmartConnector executable on 64-bit machines, the 32-bit versions of
glibc, libXext, libXrender, and libXtst must be installed as well as the 64-bit versions.
Note: On Windows, do not install in a directory with an open or close parenthesis () character in the
name.
Also, see the ArcSight SmartConnector Release Notes, which describe new product features, latest
updates, and known product issues and workarounds. For information regarding operating systems
and platforms supported, see the SmartConnector Platform Support document.
Note: The 64-bit installation executables contain a subset of available SmartConnector. See the 64-
bit SmartConnector installer for your platform for the list of available connectors, or see the
document “SmartConnector 64-Bit Support” document available on Protect 724 or in the
SmartConnector Configuration Guide zip file available for download on the Micro Focus SSO Site.
If you have been running a 32-bit SmartConnector, you cannot upgrade to the 64-bit version. To
run the 64-bit SmartConnector implementation, perform a new installation.
You will be prompted for an installation destination. By default, the destination is ArcSight Manager
(encrypted). For details on destinations, see "Connector Destinations Overview" on page 67. If you need
information on a FIPS-compliant solution, see the specific connector configuration guide. The
Parameters window requests specific parameters for the particular connector you selected. These
parameters vary depending upon the device and are described and explained in the connector
configuration guide for the selected connector.
It is a good practice to develop and use a standard naming convention to specify directory locations, file
names, and menu option names for the connectors you install. Typically, if you install multiple
connectors on a particular machine, you should install each connector in a separate directory.
Connectors can also be installed from the command line (see "Installing Connectors from the Command
Line" below) or using silent mode, which answers the wizard questions from a properties file (see
"Installing Connectors in Silent Mode" below).
Tip: ArcSight recommends creating and testing the Properties file on a system other than your in-
service, production environment.
4. Continue through all connector Configuration Wizard windows. The wizard creates a Properties
file using the name and location you specified.
Note: The properties file that you create will show passwords in readable text.
5. Select Exit and click Next at the end of the setup process to ensure that the properties file is
created.
Perform the remaining steps on the system on which you want to install the SmartConnector in silent
mode:
1. Ensure that the configuration on the system on which you want to install the connector in silent
mode matches that of the machine on which you created the properties file. Otherwise, the
installation will fail.
2. Copy the Properties file from the other system to your current system, preferably to the same
directory where you downloaded the installation file.
3. Open the Properties file in an editor of your choice.
4. Find the USER_INSTALL_DIR property in the file and make sure that the path value is the absolute
path to the location where you want to install the connector on this system.
USER_INSTALL_DIR=C\:\\Program Files\\ArcSightSmartConnectors
Note: The colon (:) and backslash (\) characters must be preceded by a backslash (\).
5. Find the ARCSIGHT_AGENTSETUP_PROPERTIES property in the file and make sure that the path
value is the absolute path to the location where you copied the Properties file on this system.
For example, if you copied the Properties file to C:\properties_files\silent.properties,
the path value should be as follows:
ARCSIGHT_AGENTSETUP_PROPERTIES=C\:\\properties_files\\silent.properties
6. Modify the properties as needed. For example, modify the connectordetails.name property in
the file and change its value to the name of the connector you are going to install in silent mode.
The following is an example of a properties file:
#======================================================
# Panel 'connectordetails'
#======================================================
# Enter the connector details.
#
# Name
connectordetails.name=The Name
# Location
connectordetails.location=The Location
# DeviceLocation
connectordetails.devicelocation=The Device Location
# Comment
connectordetails.comment=The Comment
#===============================================
You can edit any property (Manager Information, user credentials) in the Properties file to suit
your needs.
Definitions of properties:
l connectordetails.name: The name of the connector in ESM.
l connectordetails.location: The name of the folder that contains the connector in ESM.
l connectordetails.devicelocation: The location of the machine on which ESM is installed.
l connectordetails.comment: Comments that were added about the connector.
7. Save the Properties file.
8. Download the connector installation file appropriate for your platform.
9. Run the following command to install the new connector in silent mode:
Note: After running the silent install, the original command in the runagentsetup.bat file is
modified after specifying the Silent Install answer file.
To correct the problem, manually edit and remove the entries between the double quotes and
return to the default setting. There should be no entries between the second double quotes. For
example, the modified script may look like this:
call arcsight.bat agentsetup -c -i "SILENT" -f "C:\ArcSight\silent_
properties_AD" %*
After manually editing the entries, it should look like this:
call arcsight.bat agentsetup -c -i "SWING" -f "" %*
To avoid this issue:
Extract first and use the silent_properties file to configure. Run the command similar to
following:
<connector_installpath>\current\bin\arcsight.bat agentsetup -c -i silent -
f 2_addwinc
Then, the runagentsetup.bat file would not contain the silent_properties and the path will
be correct.
Uninstalling a Connector
Before uninstalling a connector that is running as a service or daemon, first stop the service or daemon.
Also, be sure to remove the service files using $ARCSIGHT_HOME/current/bin/arcsight
agentsvc -r before uninstalling the connector.
The Uninstaller does not remove all the files and directories under the connector home folder. After
completing the uninstall procedure, manually delete these folders.
To uninstall on Windows:
1. Open the Start menu.
2. Run the Uninstall SmartConnectors program found under All Programs -> ArcSight
SmartConnectors (or the name you used for the folder during connector installation).
3. If connectors were not installed on the Start menu, locate the $ARCSIGHT_
HOME/current/UninstallerDatafolder and run: Uninstall_ArcSightAgents.exe
Note: To perform a silent uninstall, run the command with the following parameters:
Uninstall_ArcSightAgents.exe -i silent
Note: To perform a silent uninstall, run the command with the following parameters:
./Uninstall_ArcSightAgents -i silent
Note: For connectors running on windows platforms, there is a known limitation for upgrading the
connector from its ESM destination.
As part of the connector upgrade, some folders or files are moved from the old to the new version.
Because Microsoft Windows locks the folders or files even they are opened for a read, upgrades
could fail if locked folders or files associated with the connector installation are accessed during the
upgrade. To prevent this issue, start the connector from Start > Programs, so that no windows are
opened to run the connector, thus reducing the possibility of locked folders or files.
To upgrade:
1. From the Micro Focus SSO site, download the latest connector upgrades to the Manager. Upgrade
version files are delivered as .aup files (a compressed file set).
2. Copy the .aup file to ARCSIGHT_HOME\updates\ on a running Manager. The Manager
automatically unzips the .aup file and copies its content to ARCSIGHT_HOME\repository\.)
3. From the Console, select connectors to be upgraded (one at a time) and launch the upgrade
command for each of them.
Caution: It is important to know:
l If you have installed multiple connectors in a single JVM, select the first connector installed
in the JVM (if you select any other connector the upgrade fails) and launch the upgrade
command; this action upgrades all connectors in the JVM.
l If your connector has multiple Manager destinations, you must perform this process from
the primary Console. Any attempt to upgrade from a secondary or non-primary Console
destination will fail.
4. Upon receipt of the upgrade command, the selected connectors upgrade themselves, restart, and
send upgrade results (success or failure) back to the Console through the Manager.
Upgrade Notes
l If the upgrade is successful, the new connector starts and reports successful upgrade status.
l If the upgraded connector fails to start, the original connector restarts automatically as a failover
measure.
Tip: You may want to know:
o Should this happen, you can review the related logs. Choose Send Command -> Tech Support
-> Get Upgrade Logs from the Console menus.
o You can also use the Send Logs Wizard to collect and send logs, including upgrade logs, to
support for help.
Guides from the support website. These are the most current configuration guides available and
contain information specific to the connector device.
l Administrative permission is required to upgrade connectors.
l Versions of the connectors you want to upgrade must be available on the Manager to which you are
connected. Remote upgrade is available only in ESM 4.0 or later, and only for 4.0.2 or newer
connectors.
l As a prerequisite to upgrading Connectors, both the Manager and the connector you want to
upgrade must be running.
l If you are running a 32-bit version of a SmartConnector, you cannot convert this connector to the
64-bit version through upgrade. You must perform a new install of the 64-bit version of the
SmartConnector to run the 64-bit implementation of the connector.
Local Upgrade
To locally upgrade a connector:
1. Stop the running connector and run the connector installer. The installer prompts you for the
location to install the connector.
2. Select the location of the connector that you want to upgrade. The message "Previous
Version Found. Do you want to upgrade?" appears.
3. Select the option to continue and upgrade the connector. The original installation is renamed by
prefacing characters to the original folder name; the upgraded connector is installed in the location
$ARCSIGHT_HOME\current.
ESM not only provides the ability to centrally manage and configure connectors, but also to update
them remotely. You can use the Upgrade command on the Console to upgrade to newer versions of
connector software for managed devices.
The Upgrade command lets you launch, manage, and review the status of upgrades for all connectors.
A failover mechanism launches connectors with previous versions if upgrades fail. All communication
and upgrade processes between components (Console, Manager, and connectors) take place over
secure connections.
The Console reflects current version information for all of your connectors.
Running Connectors
Connectors can be installed and run in standalone mode, as a Windows service, or as a UNIX daemon. If
installed standalone, the connector must be started manually, and is not automatically active when a
host is re-started. If installed as a Windows service or UNIX daemon, the connector runs automatically
when the host is re-started. Admin privileges needed to install and run as a service on Windows
platforms. See "User Privileges When Installing (UNIX only)" on the next page for instructions on using
root or non-root user privileges when running as a Linux/UNIX daemon.
Caution: Some SmartConnectors require that you restart your system before configuration
changes take effect.
Connectors for scanners present a special case. To run a scanner connector in interactive mode, run
in standalone mode and not as a Windows service or UNIX daemon.
arcsight connectors
To view the connector log, read the file:
$ARCSIGHT_HOME/current/logs/agent.log
To stop all connectors, enter Ctrl+C in the command window.
Tip: On Windows platforms, connectors also can be run using shortcuts and optional Start Menu
entries.
$ARCSIGHT_HOME/logs/agent.out.wrapper.log
To reconfigure a connector as a service, run the connector Configuration Wizard again. Open a
command window on $ARCSIGHT_HOME/current/bin and run:
runagentsetup
See "Install as a Service" on page 49 for further details.
The following instructions refers to user arcsight as a generic name for any user with non-root
privileges.
When you log on as the user arcsight for installation, the ArcSight connector files will be owned by user
arcsight.
Run as the user arcsight after installation to set up the connector wizard. There are a couple of items to
note:
l If a Syslog Daemon connector is selected, then the configured port number must be 1024 or greater
for this option (see "Option 2: Install as user arcsight, run as user arcsight with port forwarding."
below).
l When running as a service, the setup wizard displays a dialog that states:
The Connector Setup Wizard is not able to modify the service configuration
because the Wizard is not running as root. Please run this Wizard as root.
Or to manually install, logged on as root, execute the following script:
$ARCSIGHT_HOME/current/bin/arcsight agentsvc -i -u user
To manually remove the service, logged on as root, execute the following
script:
$ARCSIGHT_HOME/current/bin/arcsight agentsvc -r
We do not recommend to run the Wizard as root. Instead, run the Wizard as user arcsight and then
manually install the service. Execute the following script while logged on as root to install the connector
as a service:
$ARCSIGHT_HOME/current/bin/arcsight agentsvc -i -u arcsight
The -u arcsight option means that the service will be run as user arcsight.
Option 2: Install as user arcsight, run as user arcsight with port forwarding.
This option is the same as option #1 but it also allows a Syslog Daemon to receive events that are sent
to ports below 1024. To use this option, use the same procedures as for option #1. In addition, use
another program that forwards traffic from a low number port to the port configured for the connector.
For example, if the syslog events are being sent to port 514 and the connector is configured to receive
on port 6000, the forwarder re-routes from port 514 to port 6000. There a several possible programs
that can do the port forwarding including iptables, ncat, and socat. The iptables program is packaged
with some versions of Linux/Unix and is an easy choice.
Option 3: Install as user root, run as user root.
This option is less secure than the other options since root privileges are required for installation,
configuration, and maintenance of the connectors.
A user logs on to the system as root and installs the ArcSight connector. This results in all of the
ArcSight connector files to be owned by user root. The connector setup wizard is also run while logged
on as root. If the connectors are to be run as a service, the service configuration is done by the
connector setup wizard and no additional steps are required.
Uninstalling a Connector
Before uninstalling a connector that is running as a service or daemon, first stop the service or daemon.
Also, be sure to remove the service files using $ARCSIGHT_HOME/current/bin/arcsight
agentsvc -r before uninstalling the connector.
The Uninstaller does not remove all the files and directories under the connector home folder. After
completing the uninstall procedure, manually delete these folders.
To uninstall on Windows:
1. Open the Start menu.
2. Run the Uninstall SmartConnectors program found under All Programs -> ArcSight
SmartConnectors (or the name you used for the folder during connector installation).
3. If connectors were not installed on the Start menu, locate the $ARCSIGHT_
HOME/current/UninstallerData folder and run:
Uninstall_ArcSightAgents.exe
Note: To perform a silent uninstall, run the command with the following parameters:
Uninstall_ArcSightAgents.exe -i silent
Note: To perform a silent uninstall, run the command with the following parameters:
./Uninstall_ArcSightAgents -i silent
The parameters for this type of connector can be entered manually for a few lines of data, or, for a
larger number of entries, you can import a .csv file. You can also create a .csv file by exporting data
you’ve already entered. See "Importing and Exporting CSV Files" on the next page for specific steps.
If needed, use the Export button to export your parameter table data into an external .csv file to save
for later use.
Note the following when using this feature:
l Columns that contain private data (shown as asterisks), such as passwords, will not appear in
exported files after using the Export button.
l After importing a .csv file (using the Import button), data in private columns remain hidden (shown
as asterisks).
l Although you can manually enter a private column (either by adding the column to your CSV within a
spreadsheet program or by filling it in through the Configuration Wizard), it still will not appear in any
exported files. This is a precautionary measure.
l Importing data from a .csv file (using the Import button) causes all existing data in the table to be
removed and replaced by the incoming data.
3. Click the Import button on the Import window. This populates the connector parameters fields.
4. You can add more rows manually (using the Add button) and then export the resulting table
(using the Export button) to an external .csv file for later use.
Note: The example above shows a “Password” column within the Configuration Wizard that
does not appear in the original .csv file. This private column does not contain actual password
data and will not be included in an exported file.
Modifying Connectors
This section addresses modifying connectors parameters you initially configured through the wizard,
including destination parameters, service settings, and setting global parameters.
runagentsetup
The following window is displayed.
Modify Connector
To make changes to the initial values set during connector installation and configuration, select Modify
Connector.
To add a destination:
1. After running the wizard, Modify Connector is selected by default. Do not change this selection.
2. Click Next. On the window displayed, select Add, modify, or remove destinations.
3. Click Next. The selections displayed depend upon the destination or destinations previously
configured. You can modify the parameters and settings for these destinations, or you can select
Add destination to add another destination.
4. Click Next; the window for adding, modifying, or removing destinations will be displayed.
To remove a destination:
1. After running the wizard, Modify Connector is selected by default. Do not change this selection.
2. Click Next. Select Add, modify, or remove destinations.
3. Click Next. From the list of destination selections, select the destination to remove.
4. Click Next. Select Remove destination.
5. Click Next. The destination removal is started.
6. Click Next. The destination removal is completed.
7. Click Next. Choose Exit, to complete the connector modification, or choose Continue, to continue
to make connector modifications. Click Next to exit or continue.
as specifying filtering conditions. Based upon filtering conditions, SmartConnectors can filter events
sent to the selected destination.
1. After running the wizard, Modify Connector is selected by default. Do not change this selection.
2. Click Next. On the window displayed, select Add, modify, or remove destinations.
3. Make sure your destination is selected and click Next.
4. Select Modify destination settings to configure the following parameters:
Reregister Destination
When the Manager recognizes a connector, it generates an ID token the connector uses to identify its
security events. If the Manager stops accepting events from a connector for an unknown reason, or if
you have upgraded a connector but its resource was removed from the database, you may need to re-
register the connector.
To reregister destination:
1. After running the wizard, Modify Connector is selected by default. Do not change this selection.
2. Click Next. Select Add, modify, or remove destinations.
3. Click Next. Select a current destination from the choices displayed. These vary depending upon
initial connector configuration.
4. Click Next. Select Reregister destination.
5. Click Next. Enter any credentials required depending on the destination for the connector. The
window is not displayed for destinations that do not require credentials.
Install as a Service
This section describes how to run a connector as a service, and how to remove a connector service.
FIPS mode Select to Enabled to enable FIPS compliant mode. To enable FIPS
Suite B Mode, see Enable FIPS Suite B Mode for instructions.
Initially, this value is set to Disabled.
Remote Management Listener Port The remote management device will listen to the port specified in
this field. The default port number is 9001.
Preferred IP Version When both IPv4 and IPv6 addresses are available for the local
host (the machine on which the connector is installed), you can
choose which version is preferred. Otherwise, you will see only one
selection. The initial setting is IPv4.
If Format Preserving Encryption was left as Disabled during connector installation, you can set to
Enabled and configure the other encryption-related parameters, shown below. If Format Preserving
Encryption was set to Enabled during connector installation, encryption parameters cannot be modified.
A fresh installation of the connector will be required to make any changes to encryption parameters.
The following parameters should be configured only if you are using Micro Focus SecureData solutions
to provide encryption. See the Micro Focus SecureData Architecture Guide for more information.
Format Preserving Encryption Data leaving the connector machine to a specified destination can
be encrypted by selecting ‘Enabled’ to encrypt the fields
identified in ‘Event Fields to Encrypt before forwarding events. If
encryption is enabled, it cannot be disabled. Changing any of the
encryption parameters again will require a fresh installation of the
connector.
Format Preserving Host URL Enter the URL where the Micro Focus SecureData server is
installed.
Proxy Server (https) Enter the proxy host for https connection if any proxy is enabled
for this machine.
Proxy Port Enter the proxy port for https connection if any proxy is enabled
for this machine.
Format Preserving Identity The Micro Focus SecureData client software allows client
applications to protect and access data based on key names. This
key name is referred to as the identity. Enter the user identity
configured for Micro Focus SecureData.
Format Preserving Secret Enter the secret configured for Micro Focus SecureData to use for
authentication.
Event Fields to Encrypt Recommended fields for encryption are listed; delete any fields
you do not want encrypted from the list, and add any string or
numeric fields you wish to be encrypted. Encrypting more fields
can affect performance, with 20 fields being the maximum
recommended. Also, because encryption changes the value, rules
or categorization could also be affected. Once encryption is
enabled, the list of event fields cannot be edited.
After making your selections, click Next. A summary screen is displayed. Review the summary of your
selections and click Next. Click Continue to return to the Add a Connector window. Continue the
installation procedure with Select Connector and Add Parameter Information.
Additional Configuration
The following topics are additional configuration settings.
Feature Usage
The filtering feature applies to the raw event field in the ArcSight security event. During the flow of the
security events through the connector, the raw event field is extracted and evaluated to apply the filter.
To use the filtering feature, two out of the following three properties should be added to the
agent.properties file. The first parameter must always be included plus one of the other two. They
are:
customeventsfilter.regex.enabled=false
customeventsfilter.regex.pattern.include=
customeventsfilter.regex.pattern.exclude=
To apply filtering, set the first property to true and enter a valid regex pattern in one of the other two
properties. There is no need to add these properties to the agent.properties file if you do not
change them from their default values. See Java Regex Patterns.
Note: If the feature is enabled and both patterns are inadvertently defined, the exclude pattern
takes precedence and the include pattern is ignored.
Note: Enabling the filter through an include pattern filters out all the events in the raw event field
that do not have the pattern in question. Therefore, be certain of the outcome that you want to
achieve before enabling the include filter.
Note: All properties are considered unique to the agent. Therefore, avoid defining any property
multiple times for either the include or exclude patterns.
All device events have the raw events field present when they reach the connector, and will be impacted
by using this feature. Some internal events, such as agent:017 (get status), also have the rawEvent
field present in the event and will be impacted by the filtering feature. Most of the internal events, such
as agent:030, agent:031, or agent:050 do not have the rawEvent field in the event and will not
be impacted. This feature only impacts the events that have a non-empty rawEvent field.
In case you enable the feature but use an invalid or empty pattern on both include and exclude pattern
fields, a Get Status command shows a message similar to the following for the filtering state:
Custom Filtering: Events Filtering State............Events Filtering Disabled
Due to Syntax Error in User Defined Regex
The following table shows the various states of the filter under different user entry combinations.
customeventsfilter.regex. customeventsfilter.
customeventsfiler.regex.enabled pattern.exclude pattern.include Result
false Any pattern (valid, Any Pattern (valid, The filtering is disabled.
invalid, or empty) invalid, or empty)
true Valid and non-empty Any Pattern (valid, The filtering is enabled with
pattern invalid, or empty) exclude filter. Include pattern has
no impact.
Get Status
Examples of Patterns
Patterns are compiled through the java.util.regex.Pattern class. Any non-empty pattern that
can be compiled is considered a valid pattern. Below are a few examples of valid patterns and their
results:
The following 10 messages are actual raw events. Examples of how the filtering can be used to include
or exclude events from these 10 raw events are provided in the four cases that follow this list.
1. Nov 28 22:03:21 10.0.111.2 Nov 28 2016 22:02:17: %PIX-6-106015: Deny TCP (no connection)
from 101.102.103.104/3671 to 10.0.111.22/80 flags RST ACK on interface inside
2. Nov 28 22:03:21 10.0.111.2 Nov 28 2016 22:02:17: %PIX-2-106006: Deny inbound UDP from
10.0.65.116/2908 to 10.0.126.55/123 on interface outside
3. Nov 28 22:03:53 10.0.111.2 Nov 28 2016 22:02:49: %PIX-2-106020: Deny IP teardrop fragment
(size = 32, offset = 0) from 101.102.103.104 to 10.0.126.55
4. Nov 28 22:04:09 10.0.111.2 Nov 28 2016 22:03:04: %PIX-2-106001: Inbound TCP connection
denied from 10.0.65.116/3694 to 10.0.126.55/23 flags SYN on interface outside
5. Nov 28 22:04:10 10.0.111.2 Nov 28 2016 22:03:05: %PIX-3-305005: No translation group found
for tcp src inside:10.0.112.9/37 dst outside:10.0.65.116/3562
6. Nov 28 22:04:44 10.0.111.2 Nov 28 2016 22:03:39: %PIX-2-106001: Inbound TCP connection
denied from 10.11.12.13/3699 to 10.0.126.55/8080 flags SYN on interface outside
7. Nov 28 22:05:07 10.0.111.2 Nov 28 2016 22:04:02: %PIX-4-500004: Invalid transport field for
protocol=17, from 10.0.142.116/1234 to 10.0.126.55/0
8. Nov 28 22:05:25 10.0.111.2 Nov 28 2016 22:04:20: %PIX-2-106020: Deny IP teardrop fragment
(size = 36, offset = 0) from 10.11.12.13 to 10.0.126.55
9. Nov 28 22:06:01 10.0.111.2 Nov 28 2016 22:04:57: %PIX-2-106012: Deny IP from 10.0.142.116 to
10.0.126.55, IP options: "0x1f"
10. Nov 28 22:06:10 10.0.111.2 Nov 28 2016 22:05:05: %PIX-3-305005: No translation group found
for tcp src inside:10.0.112.9/37 dst outside:101.102.103.104/3562
The following cases describe the results of four distinct filtering cases on the above raw events.
Case 1:
customeventsfilter.regex.enabled=true
customeventsfilter.regex.pattern.exclude=Deny IP.*from \\d+\.\\d+\.\\d+\.\\d+
Events #3, #8, and #9 will be dropped (excluded) from the flow. This pattern is meant to exclude all raw
events that have both the patterns <Deny IP> and <from IPaddress> in the same raw event.
Case 2:
customeventsfilter.regex.enabled=true
customeventsfilter.regex.pattern.exclude=(10.11.12.13)|(101.102.103.104)
Events #1, #3, #6, #8, and #10 will be dropped (excluded) from the flow. The pattern is meant to
exclude raw events that have the IPs 10.11.12.13 or 101.102.103.104.
Case 3:
customeventsfilter.regex.enabled=true
customeventsfilter.regex.pattern.include=(10.11.12.13)|(101.102.103.104)
Events #2, #4, #5, #7, and #9 will be dropped (excluded) from the flow. The pattern is meant to include
raw events that have the IPs 10.11.12.13 and 101.102.103.104 in them (both IPs do not need to be in the
same pattern). All other events that do not have either of the IPs will be dropped.
Case 4:
customeventsfilter.regex.enabled=false
customeventsfilter.regex.pattern.include=(10.11.12.13)|(101.102.103.104)
No filtering will be done because the enabled property is false.
Networks CSV:
The networks.csv file defines the networks used in the zones.csv file.
Tip: While creating zones, enter the exact URI for each network. Any zones connected to unknown
networks (or most likely to networks incorrectly specified) cannot be used.
Zones CSV:
The zones.csv file defines the zones within the networks already populated in the networks.csv
file. The file is divided into 5 columns and each row defines a zone. Add the Zones:
1. Add the header, like in the following example: #Name,Start Address,End Address,Parent
Group URI,Network URI with no extra spaces. The code only tolerates a difference in upper and
lower cases.
a. First column: Define the name of the zone.
b. Second column: Name the starting IP address in the range.
c. Third column: Name the ending IP address in the range. It can either IPv4 or IPv6 as long as it
the same type of the starting IP address in the previous column.
d. Fourth column: Label the URI of the parent group in the zone URI hierarchy. This is the first
part of the zone URI.
e. Fifth column: Add the network URI to define its corresponding zone. It must be an exact
match, the concatenated URI from a network defined in the networks.csv file (the third
column and second column, concatenated, in one row of the file).
Note: Events with addresses that fall outside the zones defined by the network model cannot be
changed, so defining a network model does not necessarily affect all events.
To discard incoming zones and apply new ones (where applicable), go to Destination Settings <
Network Group < Population Mode and set your SmartConnector to "Rezone (override)" instead of
"Normal". This action may also be done from ArcMC.
Debugging tips:
Note: Busy on-board connectors may impact the performance of the ArcSight Management Center
web-based interface.
Software-Based Connectors
Previously-installed, software-based connectors can be remotely managed by some ArcSight
Management Center models, but the remote management feature is disabled on software connectors
by default.
Note: You do not need to do the following processes for ESM or Express. These processes are only
done for SmartConnectors running as a service, not for standalone SmartConnectors because they
cannot be restarted automatically.
To manage software-based connectors with ArcSight Management Center, you need to enable remote
management on them. Add the following property to the user/agent/agent.properties file in the
installation directory of each connector that you want to manage with ArcSight Management Center:
remote.management.enabled=true
Restart the connector for property changes to take effect.
You can also customize the port on which the connector will be listening. By default, this port is set to
9001, but it can be changed by adding the following property to user/agent/agent.properties:
remote.management.listener.port=9002
In the example above, the connector listens on port 9002.
Caution: Only fifth-generation connectors support remote management, so you will need
connector build 4855 (4.0.5.4878.0) or later to use this feature. Remote Management is not
supported on connectors running AIX. This limitation is due to elements within the AIX platform.
Tip: Multiple software-based connectors installed on the same host require a separate port
assignment. The default port for connectors is 9001, so the second connector installed on the same
host should use an alternate port. Micro Focus recommends using port 9002, 9003, 9004, and so
on.
For a complete list of all connectors supported by ArcSight Management Center, see the ArcSight
Management Center Release Notes. You can also visit the Community site at
https://community.softwaregrp.com/t5/ArcSight/ct-p/arcsight. ArcSight adds new connectors
regularly.
Note: Load Balancer only works with connectors that use default remote management user name
and password values.
Verify with your administrator what are the correct credentials for your environment.
The default connector remote management credentials are:
l Username: connector_user
l Password: change_me
ArcSight Logger
Logger receives events from and sends to connectors, but lacks the depth of connector management
found in ESM.
A Logger-only deployment benefits from ArcSight Management Center in many ways, and provides
most, but not all, of ESM’s management function (for example, it does not contain the filter designer).
ArcSight Management Center also offers features that ESM does not, such as bulk operations (enabling
control of many connectors at one time).
ArcSight Management Center also can configure connectors with failover destinations, providing
central failover control when redundant Loggers are deployed for this purpose. All or some connectors
can be configured to send events to a second Logger or to an event file in the case of communication
failure with the primary destination.
For more detailed information about Logger, see "ArcSight Logger SmartMessage (encrypted)
Destination" on page 87
ArcSight ESM
Deploying ArcSight Management Center in an ESM environment centralizes connector upgrade, log
management, and other configuration issues. For more information, see "ArcSight Manager
(encrypted)" on page 84.
Connector Destinations
During connector installation, you are asked to select a destination for the events collected by the
connector. The following window shows the destination selections:
CEF File
This selection allows you to capture security events in a Common Event Format (CEF) file rather than
forwarding them to a Manager.
For more detailed information, see "CEF Destinations" on page 98.
Event Broker
This selection sends events in Common Event Format (CEF) or binary to an Event Broker topic. Once
events are in Event Broker, any number of applications can retrieve them.
The AUP Master Destination and Filter Out All Events should be set to True for ESM. See ArcSight
Manager (Encrypted).
For instructions about setting up FIPS with Event Broker and SmartConnectors, see Configuring FIPS
for Event Broker and SmartConnectors on https://community.softwaregrp.com/t5/ArcSight-
Knowledge-Base-Articles/Configuring-FIPS-for-Event-Broker-and-SmartConnectors/ta-p/1588700.
For instructions about configuring TLS between Event Broker and SmartConnector, see Configuring
TLS between Event Broker and SmartConnector on https://community.softwaregrp.com/t5/ArcSight-
Connectors/tkb-p/connector-documentation.
For more detailed information, see "Event Broker" on page 99.
CEF Syslog
This selection sends events in Common Event Format (CEF) (converted to bytes using the UTF-8
character encoding), and provides three protocol options: UDP, TCP, and TLS.
TCP and UDP can be used to send to Logger (TLS cannot be used for this purpose). Data received
using these protocols are received using a TCP or UDP Receiver. One such receiver can receive from
more than one connector. TCP and UDP can also be used to send to a Syslog Daemon connector.
The TLS protocol establishes a secure channel and allows for one-way or two-way authentication. If the
TLS protocol is chosen, the events can be received by the Syslog NG Connector.
For more details about this destination, see "CEF Destinations" on page 98. For more details regarding
the Syslog NG Connector, see the SmartConnector for Syslog NG Daemon.
CSV File
This selection lets you capture events a connector normally would send to the Manager into a CSV file.
This is an advanced topic; typical ArcSight configurations do not require the use of external files to
communicate events to the Manager. For more information, see "CSV File Destination" on page 107.
Raw Syslog
This destination sends raw syslog events through the UDP, TCP, or TLS protocol. This destination is
used with the connector for Raw Syslog Daemon to collect raw, unparsed events for further processing.
For more detailed information, see "Raw Syslog Destination" on page 110. If you are transporting data to
ArcSight Logger, you can use specific configuration parameters to provide minimal normalization of the
syslog data (for source and timestamp).
Add Destinations
Connectors send a copy of events to each additional destination for which it is configured. Additional
destinations can be useful, for example, when you have a development ArcSight environment working
in parallel with your production environment and you want to test rules and reports. You can configure
multiple destinations and also have failover destinations for when the primary destination is unavailable.
In such cases, you can configure the connector to send alerts to both your production Manager and
your development Manager to be able to view real-time event flows on both systems. Because the
destinations are independent, you do not compromise the events sent to the production Manager. For
more information on how to add, refer to "Add, Modify, or Remove Destinations" on page 46.
Failover Destinations
Each connector destination can have a failover destination that receives security events from the
connector for which it is configured. The failover activates when the primary destination (such as an
Manager) is not available (as when a network problem occurs) or is not keeping up with incoming
events. These events are backed up to the failover destination. The connector also, when possible,
caches the events and resends them to the primary destination when flow is restored.
A failover destination is not active when the primary destination is available, so the reports and replay
features within the secondary Manager could contain incomplete information. This feature performs as
a real-time alternative for severe problems with the primary destination. Refer to Add a Failover for
more information.
Batching SmartConnectors can batch events to increase performance and optimize network bandwidth. When
activated, SmartConnectors create blocks of events and send them when they either (1) reach a
certain size or (2) the time window expires. You can also prioritize batches by severity, forcing the
SmartConnector to send the highest-severity event batches first and the lowest-severity event
batches later.
Enable Create batches of events of this specified size (100, 200, 300, 400, 500, or 600 events). The default is
Batching (per 100.
event)
Caution: You could potentially lose data with batch sizes 500 and 600. Contact Customer Support
before using 500 or 600 batch size.
Enable The SmartConnector sends the events if this time window expires (1, 5, 10, 15, 30, 60).
Batching (in
Default is 5.
seconds)
Batch By This is Time Based if the SmartConnector should send batches as they arrive (the default) or
Severity Based if the SmartConnector should send batches based on severity (batches of Highest
Severity events sent first).
Time Correction The settings in this group provide several ways to fix problems with devices that do not report the
time correctly.
Use Connector (No | Yes) Override the time the device reports and instead use the time at which the connector
Time as Device received the event. This option assumes that the connector is more likely to report the correct time.
Time
Default is No.
Enable Device The SmartConnector can adjust the time reported by the deviceReceiptTime field, using this
Time Correction setting. This is useful when a remote device's clock isn't synchronized with the ArcSight Manager.
(in seconds) This should be a temporary setting. The recommended way to synchronize clocks between Manager
and devices is the NTP protocol. This parameter also affects the startTime and endTime fields.
Default is 0.
Enable The SmartConnector can also adjust the time reported by the Connector Time SmartConnector itself,
Connector Time using this setting. This is for informational purposes only and lets you to modify the local time on
Correction (in the SmartConnector. This should be a temporary setting. The recommended way to synchronize
seconds) clocks between Manager and SmartConnectors is the NTP protocol.
Default is 0.
Set Device Time (Disabled | <TimeZone>) (Default is Disabled) Ordinarily, it is presumed that the original device is
Zone To reporting its time zone along with its time. And if not, it is then presumed that the SmartConnector
is doing so. If this is not true, or the device isn't reporting correctly, you can switch this option from
Disabled to GMT or to a particular world time zone. Select from the options available in the drop-
down list. That zone is then applied to the time reported.
Future The connector auto-corrects if the detect time is greater than the connector time by Future
Threshold Threshold seconds. If either or both of the future and past thresholds are negative, auto-correction
is disabled.
Default is -1.
Past Threshold The connector auto-corrects if the detect time is earlier than the connector time by Past Threshold
seconds.
Default is -1.
Device List A comma-separated list of the devices to which the thresholds apply.
The default, (ALL) means all devices.
Time Checking
Future The number of seconds by which to extend the connector's forward threshold for time checking.
Threshold Default is 5 minutes (300 seconds).
Past Threshold The number of seconds by which to extend the connector's rear threshold for time checking.
Default is 1 hour (3600 seconds).
Frequency The SmartConnector checks its future and past thresholds at intervals specified by this number of
seconds.
Default is 1 minute (60 seconds).
Cache Changing these settings does not affect the events cached, it only affects new events sent to the
cache.
Cache Size SmartConnectors use a compressed disk cache to hold large volumes of events when the ArcSight
Manager is down or when the SmartConnector receives bursts of events. This parameter specifies
the disk space to use. The default is 1 GB which, depending on the connector, can hold about 15
million events, but it also can go down to 200 MB. When this disk space is full, the SmartConnector
drops the oldest events to free up disk cache space. Select from the options available in the drop-
down list.
Default is 1 GB.
Notification How often to send notifications when the notification threshold is reached. Select from the options
Frequency available in the drop-down list.
Default is 10 min.
Maximun File The value set in the user properties represents the maximum number of cache files that guarantees
Count no events dropping, and not the actual amount of cache files created for ingestion. Basically, cache
enters in Event drop mode after the number of cache files reaches the limit set. Alternatively, when
the number of cache files reaches double the amount set, caching enters into File drop mode.
Network
Heartbeat This setting controls how often the connector sends a heartbeat message to the ArcSight Manager.
Frequency The default is 5 seconds, but it can go from 5 seconds to 10 minutes. Note that the heartbeat is also
used to communicate with the SmartConnector; therefore, if its frequency is set to 10 minutes, then it
could take as much as 10 minutes to send any configuration information or commands back to the
SmartConnector. Select from the options available in the drop-down list.
Default is 10 seconds.
Enable Name (No | Source/Dest only | Yes) The SmartConnector tries to resolve IP addresses to host names, and
Resolution host names to IP addresses, if the event rate allows it and if required. This setting controls this
functionality. The Source, Target and Device IP addresses and Hostnames may also be affected by
this setting. The Source/Dest Only choice means that the device address and device host name
fields are ignored for name resolution.
Default is Yes.
Name This is the amount of time (Time to Live) the name resolution is to be in effect. The name resolution
Resolution TTL entries are cached for this time (default is 3600).
(secs)
Wait For Name (Yes | No) If set to Yes, the SmartConnector waits for name resolution to be completed. When Yes is
Resolution selected, event processing might be slowed down significantly and even cause lost events.
Default is No.
Name (Yes | No) If set to Yes, the host name and DNS domain fields are empty, and the corresponding user
Resolution name field appears as an e-mail address, then the domain from the e-mail address is put in the DNS
Domain from domain field. This only affects the source and destination fields.
Email
Default is Yes.
Clear Host (Yes | No) If set to Yes and the host name field is set to an IP Address that matches the
Names Same as corresponding IP Address field, then the host name field is cleared. This affects the source,
IP Address destination, and device fields.
Default is Yes.
Set Host Names (Yes | No) If set to Yes, host names that remain unresolved are set to IP addresses.
to IP Addresses
Default is No.
When Unknown
Don’t Resolve By default, host names are resolved to their IP addresses. You have the option to specify a regular
Host Names expression for all or part of a host name for which you do not want the system to attempt host name
Matching resolution to an IP address.
When this option is configured, the system cannot resolve host names matching this expression.
Don’t Reverse- By default, IP addresses are resolved to their domain names. You have the option to specify IP
Resolve IP address ranges for which you do not want the system to attempt reverse-resolution to domain
Ranges names.
Click in the field to enter the IP address range. To enter a single IP address, enter the address under
the From column and leave the To column blank, then click Apply. For an address range, enter the
starting IP address under From and the ending address under To , then click Apply. This field lets
you to enter a list of ranges.
When this option is configured, the system cannot reverse-resolve IP addresses that fall within any
of the specified ranges.
Remove (Yes | Yes (w/ negative cache) | No) If set to No, unresolvable host names or IP addresses continue to
Unresolvable be in the cache. If set to Yes, unresolvable host names or IP addresses are removed from the cache. If
Names/IPs from set to Yes (w/negative cache), the connector remembers what names/IPs have been unresolvable so
Cache that time is not wasted trying to resolve them frequently.
Default is No.
Limit Select from a list of bandwidth options you can use to constrain the connector's output over the
Bandwidth To network. Select from the options available in the drop-down list.
Default is Disabled.
Transport Mode (Normal | Cache | Cache but send Very High severity events). You can configure the SmartConnector
to cache to disk all the processed events it receives. This is equivalent to pausing the
SmartConnector. However, you can use this setting to delay event-sending during particular time
periods. For example, you could use this setting to cache events during the day and send them at
night. You can also set the connector to cache all events, except for those marked with a very-high
severity, during business hours, and send the rest at night.
Default is Normal.
Cache Mode (Normal | Drop if Dest Down) This option is meant to be used on a primary destination to control the
caching behavior of the primary destination when it is down, and the connector starts sending
events to the failover destination. In the Normal mode, events are cached and sent to the primary
destination when it comes back up. In the Drop if Dest Down mode, the events are not cached and
dropped and therefore not sent to the primary destination when it becomes available again.
Default is Normal.
Address-Based (Yes | No) If Yes, the default zones built into the connector will be used to assign zones. These zones
Zone Population are only used if a network model has not been sent by ESM or ArcMC, or if that network model does
Defaults not cover some addresses. If the Address-Based Zone Population setting (below) is specified, you
Enabled may want to change this to No.
Default is Yes.
Address-Based If specified in setup or ArcMC, this is a comma-separated list that must contain a multiple of three
Zone Population items. The first of each three is the starting IP address of a zone, the second is the ending IP
address of the zone, and the third is the URI of the zone to assign to addresses in that range. These
zones are only used if a network model has not been sent by ESM or ArcMC, or if that network model
does not cover some addresses. If Address-Based Zone Population Defaults Enabled is set to Yes, the
zones specified here take precedence over those.
For example for two zones this could be: 15.0.0.0,15.255.255.255,/All Zones/ArcSight System/Public
Address Space Zones/Hewlett-Packard Company,17.0.0.0,17.255.255.255,/All Zones/ArcSight
System/Public Address Space Zones/Apple Computer Inc.
Zone Population (Normal | Rezone (override) | No Zoning (clear)) Setting to Normal means zones are computed and
Mode assigned, if not already set. Rezone (override) re-computes and re-assigns already populated zones.
No Zoning (clear) clears the zones, if already populated.
Default is Normal.
Customer URI Applies the given customer URI to events emanating from the connector. Provided the customer
resource exists, all customer fields are populated on the ArcSight Manager. If this particular
connector is reporting data that might apply to more than one customer, you can use Velocity
templates in this field to conditionally identify those customers.
Field Based Field-based aggregation implements a flexible aggregation mechanism; two events are aggregated
Aggregation if only the selected fields are the same for both events.
Note: Field-based aggregation creates a new alert that contains only the fields that were specified,
so the rest of the fields are ignored, unless “Preserve Common Fields” is set to “Yes”.
SmartConnector aggregation significantly reduces the amount of data received, and should be
applied only when you use less than the total amount of information the event offers. For example,
you could enable field-based aggregation to aggregate "accepts" and "rejects" in a firewall, but you
should use it only if you are interested in the count of these events, instead of all the information
provided by the firewall.
Time Interval Choose a time interval, if applicable, to use as a basis for aggregating the events the connector
collects. Aggregation time interval and threshold settings need to both be set in order for the
aggregation to be enabled. Select from the options available in the drop-down list.
Default is Disabled.
Event Choose a number of events, if applicable, to use as a basis for aggregating the events the connector
Threshold collects. This is the maximum count of events that can be aggregated; for example, if 900 events
were found to be the same within the time interval selected (for example, contained the same
selected fields) and you select an event threshold of 500, you then receive two events, one of count
500 and another of count 400. This option is exclusive of Time Interval. Select from the options
available in the drop-down list.
Default is Disabled.
Field Names Choose one or more fields, if applicable to use as the basis for aggregating the events the connector
collects. The result is a comma-separated list of fields to monitor.
Fields to Sum Choose one or more fields, if applicable, to use as the basis for aggregating the events the connector
collects.
If specified, this set of numeric fields is summed rather than aggregated, preserved, or discarded.
The most common fields to sum are bytesIn and bytesOut . Note that if any of the fields listed
here are also in the list of field names to aggregate, they are aggregated and not summed.
Preserve (Yes | No) Choosing Yes adds fields to the aggregated event if they have the same values for each
Common Fields event. Choosing No, the default, ignores non-aggregated fields in aggregated events.
Filter Filter Aggregation is a way of capturing aggregated event data from events that would otherwise be
Aggregation discarded due to an agent filter. Only events that would be filtered out are considered for filter
aggregation (unlike Field-based aggregation, which looks at all events).
Time Interval Choose a time interval, if applicable, to use as a basis for aggregating the events the connector
collects. It is exclusive of Event Threshold. Select from the options available in the drop-down list.
Default is Disabled.
Event Choose a number of events, if applicable, to use as a basis for aggregating the events the connector
Threshold collects. This is the maximum count of events that can be aggregated; for example, if 900 events
were found to be the same within the time interval selected (for example, contained the same
selected fields) and you select an event threshold of 500, you then receive two events, one of count
100 and another of count 400. This option is exclusive of Time Interval. Select from the options
available in the drop-down list.
Default is Disabled.
Fields to Sum (Optional) Choose one or more fields, if applicable, to use as the basis for aggregating the events the
connector collects.
Processing
Preserve Raw (Yes | No) Some devices contain a raw event that can be captured as part of the generated alert. If
Event that is not the case, most connectors can also produce a serialized version of the data stream that
was parsed/processed to generate the ArcSight event. This feature allows the connector to preserve
this serialized "raw event" as a field in the event inspector. This feature is disabled, by default, since
using raw data increases the event size and therefore requires more database storage space.
You can enable this by changing the Preserve Raw Event setting. If you choose Yes, the serialized
representation of the "Raw Event" is sent to the selected destination and preserved in the Raw
Event field.
Default is No.
Turbo Mode If your configuration, reporting, and analytic usage permits, you can greatly accelerate the transfer of
a sensor's event information through SmartConnectors by choosing one of two "turbo" (narrower
data bandwidth) modes.
Complete is the default transfer mode, which passes all the data arriving from the device, including
any additional data (custom, or vendor-specific). This corresponds to turbo.enabled=false on
the Manager. Since this value is not the default, be sure to add this property to the Manager’s
<ARCSIGHT_HOME>/config/server.properties file. After making changes to this file, you need to
restart the Manager.
The first level of Turbo acceleration is called Faster and drops just additional data, while retaining all
other information. The Fastest mode eliminates all but a core set of event attributes, in order to
achieve the best throughout. Consider the possible effects such a restricted data set might have
from a given device (for example, on reports, rules, threat resolution) before selecting it.
The specific event attributes that apply to these modes in your enterprise are defined in the
<ARCSIGHT_HOME>/config/server.default.properties file for the ArcSight Manager. Because these
properties may have been adjusted in the corresponding server.properties file for your needs, you
can refer to this server.properties file for definitive lists. Refer to the ESM Administrator’s Guide, topic
on “Managing and Changing Properties File Settings” for details.
Only scanner SmartConnectors must run in Complete mode, to capture the additional data.
Note: SmartConnector Turbo Modes are superseded by the Turbo Mode in use by the ArcSight
Managers processing their events. For example, a Manager set to Faster cannot pass all the data
possible for a SmartConnector that is set for the default of Complete.
Enable Note: If you have already used this feature for setting up previous SmartConnectors, you can continue
Aggregation (in to do so. However, ArcSight recommends that you use the new "Field Based Aggregation" on
secs) page 76 feature as a more flexible option.
Here is the description of the legacy “Enable Aggregation” feature, for those who are still using it:
When enabled, Enable Aggregation (in seconds) aggregates two or more events on the basis of the
selected time value. (Disabled, 1, 2, 3, 4, 5, 10, 30, 60)
Default is Disabled.
The aggregated event shows the event count (how many events were aggregated into the
displayed event) and event type. The rest of the fields in the aggregated event take the values of
the first event in the set of aggregated events.
Limit Event You can moderate the SmartConnector's burden on the CPU by reducing its processing rate. This can
Processing Rate also be a means of dealing with the effects of event bursts.
The choices range from Disabled (no limitation on CPU demand) to 1 eps (pass just one event per
second, making the smallest demand on the CPU).
Be sure to note that this option's effect varies with the category of SmartConnector in use, as
described in the SmartConnector Processing Categories table.
Fields to Using MD5 hashing, this option lets you to specify a list of fields for obfuscation in a security event.
Obfuscate In FIPS mode, SHA-256 is used.
Store Original (Disabled | Flex Date 1) This parameter lets you to move the original device receipt time to a
Time In specified field if altered by the time correction.
Default is Disabled.
Enable Port- (No | Yes) If set to Yes and one of the two fields destination port and application protocol is set, and
Service the other is not, the one that is set is used to set the other. For example, if the destination port is 22
Mapping and application protocol is not set, then the application protocol is set to ssh.
Default is No.
Uppercase User (Disabled | Enabled (orig to ID) | Enabled(orig to ID or Flex) | Enabled(orig to Add. Data))
Names
If set to any of the enabled settings, the two user name fields are automatically changed to
uppercase.
The original values are saved as follows:
l Enabled (orig to ID) saves the original values to the sourceUserID and destinationUserID fields,
respectively, overwriting any values that may have been there previously.
l Enabled (orig to ID or Flex) saves the original values in the same fields if they do not already
contain values, or to the flexString1 (source) and flexString2 (destination) fields if the ID
fields do contain values.
l Enabled (orig to Add. Data) saves the original values to additional data fields called
OrigSrcUsrName and OrigDstUsrName , respectively.
Note: The uppercase operation is typically done using the default Locale for the chosen platform.
You can set this to a particular Locale by setting the connector.uppercase.user.name.locale property
in agent.properties to the desired Locale (using "en_US" for U.S. English, for example).
Default is Disabled.
Enable User (Yes | No) If this is set to yes and the destination user name contains commas in the event, this
Name Splitting parameter duplicates that event. Each user name in the list is placed in one of the events.
For example, if the destination user name in an event is “User 123, User 456”, then that event is sent
twice, with the destination user name set to “User 123” in the first and “User 456” in the second.
Default is No.
Split File Name (Yes | No) If this is set to yes and an event’s file name field is set but its file path field is not, this
into Path and parameter splits the file name into a path and a name, placing each part into appropriate fields.
Name
For example, if the file name field is set to C:\dir\file.ext and the file path is not set, then the
file path is set to C:\dir and the file name to file.ext. The separator character can be either \ or /
as the system looks to the SmartConnector to determine its platform.
Default is No.
Generate (Yes | No) If set to yes and some incoming event data cannot be parsed (perhaps because a device
Unparsed has been upgraded since the SmartConnector parser was written), then a special event named
Events “Unparsed Event” is generated. The raw event appears in the event message field.
If set to No, the SmartConnector log files indicate the unparsed events.
Default is No.
Preserve System (Yes | No) If set to yes, internal system health events are preserved.
Health Events
SmartConnectors generate system health events that provide information about the systems on
which they are installed (for example, disk usage, network memory, JVM memory, percentage of
processing of CPU memory usage, and so forth). By default, these events are not retained or passed
on to ArcSight destinations and, therefore, not available for viewing. Setting this option to yes makes
them available in the Console or any destination like Logger.
Default is No.
Payload Some SmartConnectors use Payload sampling to send a portion of packet payload (as opposed to
Sampling (when the complete payload) along with the original event. This portion is retrieved using the on-demand
available) payload retrieval in the event inspector.
Maximum You can configure the maximum length of the payload sample using the following values:
Length
l Discard
l 128 bytes
l 256 bytes
l 512 bytes
l 1 Kbyte
When the Discard option is chosen, no payload sample is sent inside the original event.
Default is 256 bytes.
Mask Non- (False | True) This feature lets you to mask the non-printable characters in the payload sample.
printable
Default is False.
Characters
Filters Agent severity is the translation of the device severity into normalized values. For example, some
connectors use a device severity scale of 1-10, whereas others use a scale of high, medium and low.
These values are normalized into a single agent severity scale. The default scale is Low, Medium, High,
and Very High. An event can also be classified as Unknown if the data source did not provide a
severity rating.
Filter Out Filters for SmartConnectors are exclusive (filter out). Events that meet the connector filtering criteria
are not forwarded to the destination. During SmartConnector set up, you can configure the connector to
use filter conditions that do not pass events to the destination according to specific criteria. For
example, you can use filters to exclude events with certain characteristics or events from specific
network devices.
Very High Enter a filter condition to sort for very high severity events.
Severity Event
Definition
High Severity Enter a filter condition to sort for high severity events.
Event Definition
Low Severity Enter a filter condition to sort for low severity events.
Event Definition
EQ equal to
NE not equal to
LT less than
GT greater than
Like standard CCE operator for simple pattern matching for string type: _
wildcard for single character, % wildcard for any number of characters
InGroup for asset in the specified asset category or zone in the specified zone
group
Is tests true for the selected state, “NULL” or “NOT NULL” . Do not use all
uppercase of “Is”.
Parameter Description
Manager This is the local host name, IP address, or fully-qualified domain name of the machine where the
Hostname ArcSight Manager is installed. This name is what all clients (such as ArcSight Console) specify to talk
to the Manager. Using a host name and especially a fully-qualified domain name instead of an IP
address is recommended for flexibility.
The Manager host name is used to generate a self-signed certificate. The Common Name (CN) in the
certificate is the Manager host name that you specify in this screen. Although the Manager uses a
self-signed certificate by default, you can switch to using a CA signed certificate if needed. See the
ESM Administrator's Guide for more information.
Manager 8443
Port
AUP Default: false. A connector can send events to ESM and non-ESM destinations simultaneously. In this
Master configuration, it is helpful to use the AUP Master Destination feature. See ArcSight Content AUPs for
Destination more information.
Note: Set this to True for ESM to use zone information from the Manager for non-Manager
destinations, such as SmartMessage (Logger) or Event Broker.
Filter Out Default: false. If AUP Master Destination is set to true, you may or may not want to send this
All Events connector's events to that Manager. If the Manager should not get the events, set this to true. In that
case the manager will only be used as a source of zone information. An example of when this would
be a useful case is if the connector is sending events to the Event Broker, and ESM is reading those
events from there.
3. Click Next. You will see the Performing add destination details.
4. Click Next to continue.
5. The certificate import window for the ArcSight Manager is displayed. Select Import the certificate
to the connector from destination and click Next. (If you select Do not import the certificate to
connector from destination, the connector installation will end.)
6. You will see the dialog box with information about the connector(s) that have been updated and
the primary destination. Click Next to continue.
7. Click Exit to complete the installation.
Note: The SmartMessage secure channel uses HTTPS (secure sockets layer protocol) to send
encrypted events to Logger. This is similar to, but different from, the encrypted binary protocol
used between connectors and the ESM Manager.
Use port 443 (rather than ArcSight traditional port 8443) because the secure channel uses HTTPS.
connector.
Parameter Description
Port The destination port 443 for Logger Appliance or 9000 for Software Logger.
Compression The data compression mode checkbox. Select to enable or leave as default for disable.
Mode
CEF Version Select 0.1 or 1.0 from the drop-down menu. Select 0.1 if you are not sure the chosen destination can
handle CEF 1.0, which supports both IPv4 and IPv6 modes.
0.1 - The Device Address, Source Address, Destination Address, and Agent Address fields will always be
IPv4 or will be omitted. If there are any IPv6 addresses, they will be in Device Custom IPv6 Address
fields. Bytes In and Bytes Out fields are limited to the size of an integer (up to 2^31-1).
1.0 - Any of the address fields can be either IPv4 or IPv6 and the Bytes In and Bytes Out fields can be
long values (up to 2^63-1).
1. Click Next. If you haven’t already imported the certificate, the Logger certificate message to import
the certificate to connector displays.
2. Ensure the Import the certificate to connector from destination option is selected and click Next.
3. Navigate through the subsequent windows until receiving a message that confirms the
configuration was successful. Select Exit and click Next to exit the wizard.
7. Click Next. Select ArcSight Logger SmartMessage (encrypted). See "Connector Destinations" on
page 67 to view the options.
8. Click Next. Enter the Logger Host Name/IP, leave the port number at default (443) or change it to
9000 if the destination is a software logger, and enter the Receiver Name.
9. Click Next. If you haven’t already imported the certificate, the Logger certificate message to import
the certificate to connector displays.
10. Ensure the Import the certificate to connector from destination option is selected and click Next.
11. Click Next. A message confirms that the configuration was successful. Select Exit and click Next to
exit the wizard.
12. Restart the connector for changes to take effect.
Note: The Forwarding Connector is a separate installable file, named similarly to this: ArcSight-
6.x.x.<build>.x-SuperConnector-<platform>.exe.
Use Forwarding Connector build 4810 or later for compatibility with Logger 1.5 or later.
1. Follow the instructions in the connector Configuration Guide for your device to install the
connector.
2. When you see the type of destination window, select ArcSight Logger SmartMessage (encrypted).
See "Connector Destinations" on page 67 to view the options.
3. Click Next. Enter the Logger Host Name/IP, leave the port number at default (443) or change it to
9000 if the destination is a software logger, and enter the Receiver Name.
4. Click Next. You will get a Logger certificate message to import the certificate to connector.
5. Ensure the Import the certificate to connector from destination option is selected and click Next.
6. Click Next. A message confirms that the configuration was successful. Select Exit and click Next to
exit the wizard.
7. Restart the connector for changes to take effect.
To configure the Forwarding Connector to send CEF output to Logger and send events to another
Manager at the same time, see "Sending Events to Both Logger and a Manager" on page 90.
Note: When Logger SmartMessage Pool destination is used, the connector cannot be managed
through the ArcSight Management Center 2.0 and earlier versions.
5. Click Add to add each logger pool member and enter the host name, port number, and receiver
name fields. The parameters and buttons are described in the following tables.
Parameter Description
Port The destination port 443 for Logger Appliance or 9000 for Software Logger.
Compression The data compression mode checkbox. Select to enable or leave as default for disable.
Mode
CEF Version Select 0.1 or 1.0 from the drop-down menu. Select 0.1 if you are not sure the chosen destination can
handle CEF 1.0, which supports both IPv4 and IPv6 modes.
0.1 - The Device Address, Source Address, Destination Address, and Agent Address fields will
always be IPv4 or will be omitted. If there are any IPv6 addresses, they will be in Device
Custom IPv6 Address fields. Bytes In and Bytes Out fields are limited to the size of an integer
(up to 2^31-1).
1.0 - Any of the address fields can be either IPv4 or IPv6 and the Bytes In and Bytes Out fields can
be long values (up to 2^63-1).
Button Description
Add Adds a row to the table to add a logger to a pool. Fill in the information manually. Use the checkbox for
Compression Mode to enable or disable it. The default is unchecked for disabled. The default port for
logger is 443.
Remove Removes the row corresponding to the logger from the loggersecure pool.
Import Opens a dialog window to import the .csv file type containing the pre-recorded information for
loggersecure pool.
Export Opens a dialog window where you can export and save the data entered in the panel. Use a .csv file
extension for export. The file lists Disabled for default Compression Mode and TRUE for enabled.
6. Continue until all pool members are added, then click Next.
a. If any of the parameters could not pass the verification, an error displays asking you to check
your SSL configuration.
b. Check the connectivity error by clicking No and return to the parameter window to edit the
parameter for the logger that has the error.
c. Click Next again to continue with configuration.
d. You will see a message asking you if you want to continue. Click Yes.
transport.loggersecure.connection.persistent=true
Changing the persistent value to true is not recommended if there are more than 250 Logger
connections.
CEF File
This selection lets you capture events that a connector would normally send to the ESM Manager, and
route them to a file. The format called Common Event Format (CEF) can be readily adopted by vendors
of both security and non-security devices. This format contains the most relevant event information,
making it easy for event consumers to parse and use them.
For detailed descriptions of field information, see the Cloud CEF Implementation Standard.
1. To proceed, run the Installation Wizard and choose CEF File. See "Connector Destinations" on
page 67 to view the options.
2. Enter the following values for these parameters.
Parameter What to enter or select
File The desired file rotation interval, in seconds. The default is 3,600 (one hour).
Rotation
Interval
CEF Select 0.1 or 1.0 from the drop-down menu. Select 0.1 if you are not sure the chosen destination can
Version handle CEF 1.0, which supports both IPv4 and IPv6 modes. The destination could be Logger, another
SmartConnector, or a non-ArcSight product.
0.1 - The Device Address, Source Address, Destination Address, and Agent Address fields will always
be IPv4 or will be omitted. If there are any IPv6 addresses, they will be in Device Custom IPv6
Address fields. Bytes In and Bytes Out fields are limited to the size of an integer (up to 2^31-1).
1.0 - Any of the address fields can be either IPv4 or IPv6 and the Bytes In and Bytes Out fields can be
long values (up to 2^63-1).
File Rotation
Events are appended to the current file until the rotation time interval expires or the maximum file size is
reached. When either condition is exceeded, a new current file is created and the previous current file is
renamed (as detailed below).
Event files are named using the timestamp of their creation, and all files, with the exception of the
current file, have the text 'done.cef' appended. For example, a typical CEF file set configured to rotate
every hour might consist of files named in this manner:
2010-01-28-10-55-33.cef
2010-01-28-09-55-33.done.cef
2010-01-28-08-55-33.done.cef
Event Broker
The Event Broker destination is used to send events to an Event Broker cluster, which can then further
distribute events to real-time analysis and data warehousing systems. Any application that supports
retrieving data from Event Broker can receive these events (for example, ESM, ArcSight Investigate,
Hadoop and Logger).
Note: The configuration settings for ESM must be done on the connector side, not the ESM
Console.
Specify the event topic name. All connectors that use the same logger pool need to be configured to
use the same event topic name, so the events from these connectors will be published to the same event
topic.
For Content Types CEF 0.1 and CEF 1.0, the key is sent on events with the connectors IP address and a
flag. The flag format is a single byte value. For ESM, the key is the agent ID.
The key format is: one byte flags + (4 or 16 bytes) IP (v 4 or v 6) address. Based on the value of the IP
version bit, 4 or 16 additional bytes should be examined. This is used in case the key is made longer in a
non-breaking fashion in the future.
0 IP version:
0 = IPv4
1 = IPv6
1 Key version:
Must be 0. If there are future versions of key that are not backward compatible with this definition, it
changes to 1.
For CEF 0.1 and 1.0, the events are delivered to Event Broker in their own messages, which are
distributed to the partitions of the topic defined in Event Broker in a round-robin manner. For ESM, the
events are sent in batches in a binary format. TLS encryption is supported, as is client certificate
authentication.
When TLS is enabled by setting the Use SSL/TLS parameter to true during destination configuration, a
Java KeyStore-format (.jks) file containing the certificates of the Event Broker's Kafka cluster, or a
certificate that has signed them, will be required. The location of this Trust Store file will be required
during destination configuration. See Kafka documentation at
https://kafka.apache.org/documentation.html#security_ssl for instructions.
Also, when client certification authentication is enabled by setting the Use SSL/TLS Authentication
parameter to true, a .jks file containing the private key and certificate to use must be provided. The
Event Broker cluster must have the certificate (or a certificate that has signed it) in its trust store. The
location of the Key Store file and authentication information is to be provided in the SSL/TLS Key Store
file, SSL/TLS Key Store pass, and SSL/TLS Key password parameters. The Key and Key Store
passwords are created when you set up Event Broker.
1. To proceed, run the Installation Wizard and choose Event Broker as the destination.
2. Enter values for the following parameters.
Initial Host:Port(s) This is a required field. Provide a comma-separated list of hostnames and ports for
establishing communication with the Event Broker cluster. Not all servers in the
cluster must be listed, but if none of the servers listed can be contacted, the
connector cannot send events to Event Broker. Specify at least one server. An
example would be:
kafka1.example.com:9093,kafka2.example.com:9093 .
Content Type Select these Topics for the corresponding Content Types:
ESM eb-esm
See the section on "ESM Support of Other ArcSight
Products/Components" in the ArcSight ESM Support
Matrix.
Acknowledgment mode This is a required field. The value selected determines whether the connector is to
wait for acknowledgment from Event Broker that it has received the event. Options
are:
Leader: Default. The connector waits for acknowledgment from the primary Event
Broker server for the event’s partition. This option protects against data loss in most
circumstances while providing reasonable performance; however, throughout can be
affected.
None: The connector does not wait for acknowledgment. This can result in lost
events if the receiving Kafka server fails, but has significantly higher throughout.
All: The connector waits for an acknowledgment from all Event Broker servers that
contain a backup for the event’s partition. This protects against lost events in nearly
all circumstances, but significantly reduces throughout.
Use SSL/TLS Determines whether events are sent with TLS encryption. Options are:
l True
l False (default)
If true is selected, the SSL/TLS Trust Store Password and the location of the SSL/TLS
Trust Store file are required.
SSL/TLS Trust Store file Enter the location of the Trust Store file.
SSL/TLS Trust Store Enter the password for the SSL/TLS Trust Store.
password
Use SSL/TLS Determines whether a client certificate is used for TLS to identify the connector.
Authentication Options are:
l True
l False (default)
When true is selected, Use SSL/TLS must also be enabled. The values for the
SSL/TLS Key Store File, SSL/TLS Key Store Pass, and SSL/TLS Key password
parameters also must be provided.
SSL/TLS Key Store file Enter the location of the SSL/TLS Key Store file.
SSL/TLS Key Store pass Enter the password for SSL/TLS Key Store.
CEF Syslog
The TCP and UCP destination can be used to send events to Logger, where data is received using a
TCP or UDP Receiver. One such receiver can receive from more than one connector. These can also be
used to send to a Syslog Daemon connector or non-ArcSight syslog receivers.
For detailed information about sending to Logger, see "ArcSight Logger SmartMessage (encrypted)
Destination" on page 87.
The TLS protocol provides a means of sending events through a secure channel (an option that does
not apply to Logger). This data can be received by any application that supports TLS syslog reception,
which includes ArcSight's Syslog NG Daemon connector.
1. Install the connector following the instructions in the configuration guide for your device. You may
also see the following window after you add a destination, see "Add, Modify, or Remove
Destinations" on page 46.
2. When you see the type of destination window, choose CEF Syslog. See "Connector Destinations"
on page 67 to view the options.
3. Click Next.
4. Enter the following values for these parameters.
Forwarder The CEF Forwarder mode parameter is False by default. If the destination is a Syslog Daemon
connector and you want to preserve information about the original connector, then the CEF Forwarder
mode should be set to True both in this destination and in the receiving connector. In other words, if
you have a chain of connectors connected by syslog, syslog NG, or CEF encrypted syslog (UDP), and
you want to preserve information about the original connector, the destinations should all have the
CEF Forwarder mode set to True (which is implicitly true for CEF Encrypted Syslog (UDP)), and the
connectors receiving from them should also have the CEF Forwarder mode set to True.
For example, you can configure a number of forwarders for Microsoft Windows Event Log Unified, all
sending events using the CEF Syslog destination type to one Syslog Daemon connector, which then
sends to ESM. In order for the events arriving at ESM to retain information about the specific Unified
connector that collected the event, the connector's CEF Syslog destinations should have the Forwarder
mode set to true, and the Syslog Daemon connector should also set the Forwarder mode to true. The
information will display in the original agent fields of the events.
CEF Select 0.1 or 1.0 from the drop-down menu. Select 0.1 if you are not sure the chosen destination can
Version handle CEF 1.0, which supports both IPv4 and IPv6 modes. The destination could be Logger, another
SmartConnector, or a non-ArcSight product.
0.1 - The Device Address, Source Address, Destination Address, and Agent Address fields will always
be IPv4 or will be omitted. If there are any IPv6 addresses, they will be in Device Custom IPv6
Address fields. Bytes In and Bytes Out fields are limited to the size of an integer (up to 2^31-1).
1.0 - Any of the address fields can be either IPv4 or IPv6 and the Bytes In and Bytes Out fields can be
long values (up to 2^63-1).
To decrypt the data on the receiving side, ensure that you have installed and configured the ArcSight
CEF Encrypted Syslog (UDP) connector. If the connector is not yet installed, refer to the
SmartConnector for ArcSight CEF Encrypted Syslog (UDP) for instructions.
1. Install the connector component (see the connector Configuration Guide for your device). You may
also see the following window after you add a destination, see "Add, Modify, or Remove
Destinations" on page 46.
2. When you see the type of destination window, choose CEF Encrypted Syslog (UDP). See
"Connector Destinations" on page 67 to view the options.
3. Click Next.
4. Enter the following values for these parameters.
CEF Select 0.1 or 1.0 from the drop-down menu. Select 0.1 if you are not sure the chosen destination can
Version handle CEF 1.0, which supports both IPv4 and IPv6 modes. The destination can only be the
corresponding SmartConnector.
0.1 - The Device Address, Source Address, Destination Address, and Agent Address fields will always
be IPv4 or will be omitted. If there are any IPv6 addresses, they will be in Device Custom IPv6
Address fields. Bytes In and Bytes Out fields are limited to the size of an integer (up to 2^31-1).
1.0 - Any of the address fields can be either IPv4 or IPv6 and the Bytes In and Bytes Out fields can
be long values (up to 2^63-1).
Shared Enter a 16 character shared key for encryption (Shared Secret). The same Shared Key must be used
Key (16 when configuring the CEF Encrypted Syslog (UDP) connector on the receiving side.
characters)
CSV Path The path to the output folder. If it does not exist, the folder is created.
Fields A comma-delimited list of field names to be sent to the CSV file. The default is:
event.deviceReceiptTime,event.name,event.deviceAddress,
event.deviceHostName,event.sourceAddress,
event.sourceHostName,event.sourcePort,
event.destinationAddress,event.destinationHostName,
event.destinationPort
To modify the list, each entry needs to begin with either:
l “event.” and the name of a normal pre-defined event field, or
l “additionaldata.” and the name of some additional data field that applies to this particular
connector. These names are not common across all connectors.
There are no spaces allowed around the commas in the field names. For example:
“event.deviceReceiptTime,event.name” is correct. But, “event.deviceReceiptTime, event.name” is not
correct.
File Enter the desired file rotation interval, in seconds. The default is 3,600 (one hour).
rotation
interval
Write Select true to send a header row with labels for each column, as described above.
format
header
Note: If you are transporting data to ArcSight Logger, you can use specific configuration
parameters to provide minimal normalization of the syslog data (for source and timestamp). See the
SmartConnector for Raw Syslog Daemon Configuration Guide for details.
This destination works in conjunction with the Raw Syslog connector, which captures security events in
raw syslog. When you install the Raw Syslog connector, run the connector Installation Wizard and, from
the destination selection, choose Raw Syslog. See "Connector Destinations" on page 67 to view the
options.
After you enter the raw syslog destination parameters and click Next, the connector Configuration
Wizard proceeds through the configuration process.
As shown below, the method of uploading an AUP varies depending on the ArcSight product.
ESM
Content updates are available from support. To update,
1. Download the latest AUP release.
2. Copy the .aup file to ARCSIGHT_HOME\updates\ onto a running ESM Manager. Connectors
registered to this ESM automatically download the .aup and, once completed, an audit event is
generated.
ESM/Logger
A connector can send events to ESM and Logger simultaneously. In this configuration, it’s helpful to
use the AUP Master Destination feature. AUP Master Destination allows ESM to push AUP content to
the connector used for its Logger destination(s). Logger is not capable of storing or pushing its own
AUP content.
1. Using the connector Configuration Wizard, add the ESM destination and set the AUP Master
Destination parameter to true (the default is false).
2. If you have not already done so, you can also add the Logger destination.
3. Copy the .aup file to ARCSIGHT_HOME\updates\ on the running ESM Manager you added in
step 1.
Connector
The AUP content is pushed from ESM to the connector, which then sends an internal event to confirm.
If the AUP Master Destination flag was set for the ESM destination, that AUP content is used by the
connector for Logger or any other non-ESM destinations.
Caution: The AUP Master Destination flag should be set to true for only one ESM destination at a
time. If more than one ESM destination is set and the flag is true for more than one, only the first is
treated as master.
Failover ESM destinations cannot be AUP Masters.
Logger
Logger has no facility to store or forward AUPs to connectors.
What is FIPS?
Under the Information Technology Management Reform Act (Public Law 104-106), the Secretary of
Commerce approves standards and guidelines that are developed by the National Institute of Standards
and Technology (NIST) for Federal computer systems. These standards and guidelines are issued by
NIST as Federal Information Processing Standards (FIPS) for use government-wide. NIST develops
FIPS when there are compelling Federal government requirements such as for security and
interoperability and there are no acceptable industry standards or solutions.
FIPS Suite B includes cryptographic algorithms for hashing, digital signatures, and key exchange. The
entire suite of cryptographic algorithms is intended to protect both classified and unclassified national
security systems and information.
Connector Caveats
Certain limitations apply for some connector types, as described in the sections that follow.
Password Management
Use the commands below to change your key and trust store passwords. Then update the
agent.properties file with the new value.
Store Values
Key Store (for Client Authorization) Trust Store
agentkeys agentcerts
My machine is in a different location than 'en_US' and my connectors are running into parser errors
when parsing timestamp fields.
The connector assumes a default locale of 'en_US'. If your machine is running in a different locale, your
connector may run into parsing errors when parsing timestamps. Try changing the parser locale by
adding a property 'agent.parser.locale.name=<locale of your machine>' into
user/agent/agent.properties, then restart your connector.
For example, China and France would have the following locales:
agent.parser.locale.name=zh_CN
agent.parser.locale.name=fr_FR
To use the default locale for the connector machine, you can leave the locale blank. For example:
agent.parser.locale.name=
What if my device is not one of the listed connectors?
l ArcSight offers an optional feature called the FlexConnector Development Kit (SDK), which can
assist you in creating a custom connector for your device.
l ArcSight can create a custom connector; contact customer support for more information.
My device is on the list of supported products; why doesn't it appear in the connector Configuration
Wizard?
connectors are installable based upon the operating system you are using. If your device is not listed,
either it is not supported by the operating system on which you are attempting to install, or your device
is served by a Syslog server and is, therefore, a syslog sub-connector. To install a Syslog connector,
select Syslog Daemon, Syslog Pipe, or Syslog File during the installation process.
Why isn't the SmartConnector reporting all events?
Check that event filtering and aggregation setup is appropriate for your needs.
Does a file reader SmartConnector reading files over a network share display errors when the network
share is disconnected? How can I recognize which error message refers to which file in agent.log and
agent.out.wrapper.log?
If the network share is a Linux/UNIX NFS mount or a Windows network mapped drive, the file reader
connector displays errors in the agent log.
If files are being read using a Windows UNC path that does not require network mapping, the file reader
connector cannot detect a network connection loss.
Error messages related to file access contain the file name, but error messages related to log line parsing
do not.
Are log files accessed sequentially or in parallel?
This depends upon the connector you are using. Some log file connectors process files sequentially and
others process log files in parallel.
After reading a log file, can a SmartConnector move them using NFS?
Yes. Folder Follower connectors can rename or move the files using NFS, as long as the folders
containing the log files give the correct permissions for the connector.
My SmartConnector must read log files from a remote machine through a network share. How can I do
this?
To establish a network share to a remote machine, you can use network mapping on Windows
platforms, and NFS or Samba mounting on Linux/UNIX platforms.
If you are running the connector as a Windows service, access privileges to the network share are
required. To access the user name and password panel:
1. From the Start menu, select Control Panel.
2. Double-click Administrative Tools.
3. Double-click Services.
4. Right-click the name of the appropriate connector and select Properties.
5. Click the Log on tab, and enter the user name and password for the user with access permissions to
the file share. Specify the file path using UNC notation, not as a network mapped drive.
Is there any limitation on performance relating to EPS?
These limitations are subjective and depend upon system resources, number of devices, number of
events, and so on.
How many log files can a SmartConnector access at one time?
The connector can access as many log files as it is configured with. The folders are processed in parallel.
Lastly, if the Name Resolution Domain From E-mail parameter is set to Yes, then the source and
destination DNS domain event fields are looked at. If either is empty, the corresponding user name
event field is not empty and contains an "@" character, and the corresponding host name event field is
empty, then the DNS domain event field is set to the part of the user name event field after the "@"
character.
On the other hand, the default limit is 50000 entries for each of the two caches (names => IPs, and IPs
=> names). An expiration daemon runs periodically (normally once per minute) to check for stale cache
entries, as defined by the shortest TTL set for all destinations. Older entries are simply queued for re-
resolution. If the queues are at all backed up, these refresh requests may take some time, which is why
entries that are up to twice the TTL are not considered stale when Wait For Resolution is disabled. Note
that previously, arbitrarily old entries would continue to be used, so the behavior in the case of severely
backed up queues has changed.
Under what circumstances can an entry be removed of the cache?
Cache entries are removed if 1) the size limit is reached or 2) the name or IP address is explicitly
configured to not be looked up but it was previously in the cache. Additionally, an entry can be removed
after DNS lookup fails if it has been previously configured by removing Unresovable Names /Ips from
Cache.
How should an entry be manually removed from the cache?
It is not possible to manually remove a single entry from the cache. It is only possible to flush the cache
files while the connector is stopped. The action must not be documented.