Configuration Guide

SmartConnector for Qualys QualysGuard File

February 14, 2014

Configuration Guide
SmartConnector for Qualys QualysGuard File
February 14, 2014
Copyright 2003 2014 Hewlett-Packard Development Company, L.P.Confidential computer software. Valid license
from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S.
Government under vendor's standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP products and services
are set forth in the express warranty statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions
contained herein.
Follow this link to see a complete statement of ArcSight's copyrights, trademarks and acknowledgements:
http://www.hpenterprisesecurity.com/copyright.
The network information used in the examples in this document (including IP addresses and hostnames) is for illustration
purposes only.
This document is confidential.

Revision History
Date

Description

02/14/2014

Added support for versions 7.11 and 7.12.

08/15/2013

Added support for version 7.9. Added and updated mappings.

02/15/2013

Added support for version 7.7. Added and updated mappings.

11/15/2012

Added support for version 7.4. Added and updated mappings.

08/15/2012

Added support for version 7.1. Added and updated mappings.

05/15/2012

Added new installation procedure. Updated versions supported. Added and updated mappings.

11/15/2011

Added new field mappings table for Qualys Infos Mappings to ArcSight ESM Fields; added fields mappings
to the existing field mappings tables.

08/12/2011

Corrected SmartConnector name and supported versions. Added support for QualysGuard 6.19.

05/15/2011

Updated installation parameters; new parameters for proxy server.

09/24/2010

Updated supported versions.

02/11/2010

Added support for FIPS Suite B and CEF File transport.

06/30/2009

Added support for version 6.0.

03/27/2009

Updated mappings for Device Custom Strings 2 and 6.

Configuration Guide

Contents
Product Overview............................................................................................................................................ 4
Configuration................................................................................................................................................... 4
Install the SmartConnector.............................................................................................................................. 5
Enable FIPS Mode .........................................................................................................................................10
Run the SmartConnector ...............................................................................................................................10
Device Event Mapping to ArcSight Fields ......................................................................................................11
Qualys Infos Mappings to ArcSight ESM Fields .....................................................................................11
Qualys Practices Mappings to ArcSight ESM Fields ..............................................................................11
Qualys Open Ports Mappings to ArcSight ESM Fields...........................................................................12
Qualys Scanner Mappings to ArcSight ESM Fields ...............................................................................12
Qualys Services Mappings to ArcSight ESM Fields ...............................................................................13
Qualys URIs Mappings to ArcSight ESM Fields.....................................................................................13
Qualys Vulnerability Mappings to ArcSight ESM Fields .........................................................................14
Troubleshooting .............................................................................................................................................14

Confidential

SmartConnector for Qualys QualysGuard File

SmartConnector for Qualys QualysGuard File

This guide provides information for installing the SmartConnector for Qualys QualysGuard File for report
event collection. This SmartConnector is supported on platforms that support Java 1.3 or later.
QualysGuard versions 4.0, 4.7, 5.0, 6.0, 6.5, 6.19, 7.0, 7.1, 7.4, 7.7, 7.9, 7.11, and 7.12 are supported.
See the section "Device Event Mapping to ArcSight Data Fields" later in this document for the specific
events mapped to fields in the ArcSight database.

Product Overview
Qualys QualysGuard is an on demand solution that enables organizations to discover and prioritize all
network assets; proactively identify and fix security vulnerabilities; prevent worms, viruses and trojan
horses; manage and reduce business risk; and ensure compliance with laws, regulations and corporate
security policies.
The SmartConnector for QualysGuard is an XML connector. It connects to the Qualys web interface
(over HTTPS) to retrieve reports and sends the information to the ArcSight ESM Manager.

Configuration
During the installation process, you will be asked to fill in a number of parameters. To be prepared:

If Qualys requires a Client Certificate, you will need access to the client certificate .pfx or .jkcs
file. The installation wizard asks you for the certificate type, path, and password, and will ask you
to download and save the client certificate to a particular location.

The name of a user with authority to gain access to the report repository and the password for this
user will be required.

The URL used to retrieve stored reports as well as the URL used to retrieve the list of stored
reports will be required.

If you will be going through a proxy, you will select true for "Proxy Server Used" and you also will
be asked to provide the IP address or host name and port number for the proxy server, as well as
the user name and password for proxy authentication.

You also will be asked to select one of two operational modes:

Interactive This mode is designed to be used by an operator who requires only certain reports to
be sent to ArcSight ESM. In this mode, the connector first retrieves a list of reports stored in the
user's Qualys account (unsent), and presents it in a UI window where the user can select the scan
reports to be sent to the ArcSight ESM Manager. After making a selection, clicking on the Send
button sends all the selected scanner reports to ArcSight ESM. Closing the window when all the
desired scans have been sent terminates the connector. In this mode, the connector should not be
run as a daemon/service, only as a standalone application.

Automatic This mode is designed to automatically import the reports from Qualys to the ArcSight
ESM Manager whenever a new report is generated. In this mode, the connector periodically checks
for any new scan reports. When the connector detects that a new scan has been successfully

Confidential

Configuration Guide
completed, it sends the report to the ArcSight ESM Manager. The connector can run as a service
in this mode since it is designed to run in unattended mode.

Install the SmartConnector

Before you install any SmartConnectors, make sure that the ArcSight products with which the
connectors will communicate have already been installed correctly (such as ArcSight ESM or ArcSight
Logger). This configuration guide takes you through the installation process with ArcSight Manager
(encrypted) as the destination.
For complete product information, read the Administrator's Guide as well as the Installation and
Configuration guide for your ArcSight product before installing a new SmartConnector. If you are
adding a connector to the Connector Appliance, see the ArcSight Connector Appliance Administrator's
Guide for instructions, and start the installation procedure at step 3.
Before installing the SmartConnector, be sure the following are available:

Local access to the machine where the SmartConnector is to be installed

Administrator passwords

Unless specified otherwise at the beginning of this guide, this SmartConnector can be installed on all
ArcSight supported platforms; for the complete list, see the SmartConnector Product and Platform
Support document, available from the HP SSO and Protect 724 sites.
1

Download the SmartConnector executable for your operating system from the HP SSO site.

Start the SmartConnector Installer by running the executable.

Follow the installation wizard through the following folder selection tasks and installation of the core
connector software:
Introduction
Choose Install Folder
Choose Install Set
Choose Shortcut Folder
Pre-Installation Summary
Installing...

When the installation of SmartConnector core component software is finished, the following window
is displayed.

Confidential

SmartConnector for Qualys QualysGuard File

Next, you will need to download and save the license file for this SmartConnector.
A

Click Cancel to exit the wizard at this point. Next, create a Qualys folder at the following
location:
$ARCSIGHT_HOME/current/user/agent/Qualys

Download and save the client certificate .pfx or .jkcs file to the Qualys directory you just
created. Contact Qualys support for this certificate file. The name of and path to the client
certificate file is needed during SmartConnector setup.

From $ARCSIGHT_HOME/bin, enter arcsight connectorsetup to return to the

SmartConnector Configuration Wizard. When queried whether to enter Wizard mode, click
Yes.

Select Add a Connector and click Next.

Select Qualys QualysGuard File and click Next.

Enter the required SmartConnector parameters to configure the SmartConnector, then click Next.

Confidential

Configuration Guide

Parameter

Description

Client Certificate
Required

Select 'True' if Qualys requires the connector to present an SSL client certificate;
otherwise, select 'False'.

Certificate Type

Select the SSL Keystore type, PKCS12 or JKCS. (Ignore this parameter if Qualys does
not require SSL client certificate.)

Certificate Path

Enter the SSL Keystore file path and name. This can be the path to the certificate or a
keystore containing the certificate. In either case, this file must be present in the folder
or subfolders of the folder in which the ArcSight SmartConnector is installed.
Otherwise, the connector is unable to pick up the certificate. (Ignore this parameter if
Qualys does not require SSL client certificate.)

Certificate Password

Enter the SSL Keystore password. (Ignore this parameter if Qualys does not require
SSL client certificate.)

Scan Report List URL

Enter the URL used to retrieve the list of stored reports. By default, this is set to
'https://qualysguard.qualys.com/msp/scan_report_list.php'. When Qualys requires a
client certificate, this should be set to
'https://certs.qualysguard.qualys.com/msp/scan_report_list.php'.

Scan Report URL

Enter the URL used to retrieve stored reports, given the report ID. By default, this is set
to 'https://qualysguard.qualys.com/msp/scan_report.php'. When Qualys requires a
client certificate, this should be set to
'https://certs.qualysguard.qualys.com/msp/scan_report.php'.

Qualys User

Enter the name of a user with authority to gain access to the report repository.

Qualys Password

Enter the password for the above user.

Scan Processing
Frequency (in minutes)

Enter the desired scan processing frequency for Automatic mode in minutes.

Mode

Select Interactive or Automatic. In Interactive mode, a graphical UI is displayed

showing the reports available for sending to the ArcSight ESM Manager. In Automatic
mode, the new reports are sent automatically to the ArcSight ESM Manager.

Proxy Server Used

Select true if a proxy is used; otherwise, leave the default value of false.

Proxy Server Host

Enter the IP Address or Host Name for the Internet Proxy Server (required only when
you will go through a proxy).

Confidential

SmartConnector for Qualys QualysGuard File

Parameter

Description

Proxy Server Port

Enter the number of the port on which Internet Proxy Server is running the proxy
service (required only when you will go through a proxy).

Proxy Server User

Enter the User Name used by Internet Proxy Server for proxy authentication (needed
only if your proxy uses basic authentication.)

Proxy Server Password

Enter the password for the Proxy Server User (needed only if your proxy uses basic
authentication).

The next window asks for the destination type; make sure ArcSight Manager (encrypted) is
selected and click Next. (For information about any of the other destinations listed, see the
ArcSight SmartConnector User's Guide as well as the Administrator's Guide for your ArcSight
product.)

Enter the Manager Host Name, Manager Port, and a valid ArcSight User Name and Password.
This is the same user name and password you created during the ArcSight Manager installation.
Click Next.

Enter a name for the SmartConnector and provide other information identifying the connector's use
in your environment. Click Next; the connector starts the registration process.

10 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.

Confidential

Configuration Guide

The certificate is imported and the Add connector Summary window is displayed.
11 Review the Add connector Summary and click Next. If the summary is incorrect, click Previous
to make changes.
12 The wizard now prompts you to choose whether you want to run the SmartConnector as a standalone process or as a service. If you choose to run the connector as a stand-alone process, skip
step 13. If you choose to run the connector as a service, the wizard prompts you to define service
parameters. See "Run the SmartConnector" later in this guide for more information.

Confidential

SmartConnector for Qualys QualysGuard File

13 Enter the service parameters and click Next. The Install Service Summary window is displayed.
14 Click Next.
To complete the installation, choose Exit and click Next. To enable FIPS-compliant mode, choose
Continue, click Next, and continue with "Enable FIPS Mode."

Enable FIPS Mode

15 After choosing Continue and clicking Next after connector installation, choose Enable FIPS Mode
and click Next. A confirmation window is displayed when FIPS mode is enabled.
16 Click Next. To complete installation of FIPS support, click Exit. To enable FIPS Suite B mode,
click Continue.
17 On the window displayed, select Modify Connector.
18 Select Add, Modify, or remove destinations and click Next.
19 Select the destination for which you want to enable FIPS Suite B mode and click Next.
20 Select Modify destination parameters and click Next.
21 When the parameter window is displayed, select FIPS with Suite B 128 bits or FIPS with Suite B
192 bits for the FIPS Cipher Suites parameter. Click Next.
22 The window displayed shows the editing changes to be made. Confirm and click Next to continue.
(To adjust changes before confirming, click Previous.)
23 A summary of the configuration changes made is displayed. Click Next to continue.
24 Click Exit to exit the configuration wizard.
For some SmartConnectors, a system restart is required before the configuration settings you made
take effect. If a System Restart window is displayed, read the information and initiate the system
restart operation.
Save any work on your computer or desktop and shut down any other running applications (including the
ArcSight Console, if it is running), then shut down the system.

Complete any Additional Configuration required, then continue with the "Run the SmartConnector."
For connector upgrade or uninstall instructions, see the SmartConnector User's Guide.

Run the SmartConnector

SmartConnectors can be installed and run in stand-alone mode, on Windows platforms as a Windows
service, or on UNIX platforms as a UNIX daemon, depending upon the platform supported. On
Windows platforms, SmartConnectors also can be run using shortcuts and optional Start menu entries.
If the connector is installed in stand-alone mode, it must be started manually and is not automatically
active when a host is restarted. If installed as a service or daemon, the connector runs automatically

10

Confidential

Configuration Guide
when the host is restarted. For information about connectors running as services or daemons, see the
HP ArcSight SmartConnector User's Guide.
To run all SmartConnectors installed in stand-alone mode on a particular host, open a command
window, go to $ARCSIGHT_HOME\current\bin and run: arcsight connectors
To view the SmartConnector log, read the file $ARCSIGHT_HOME\current\logs\agent.log; to
stop all SmartConnectors, enter Ctrl+C in the command window.

Device Event Mapping to ArcSight Fields

The following section lists the mappings of ArcSight data fields to the device's specific event definitions.
See ArcSight 101 for more information about the ArcSight data fields.

Qualys Infos Mappings to ArcSight ESM Fields

ArcSight ESM Field

Device-Specific Field

Agent (Connector) Severity

Very High = Urgent; High = Critical, Serious; Medium = Medium; Low

= Minimal

Destination Address

IPvalue

Destination Host Name

One of (NetbiosHostName, IPname)

Destination Port

Port

Device Custom String 1

Result

Device Custom String 2

CVEID

Device Custom String 3

Diagnosis

Device Custom String 4

Consequence

Device Custom String 5

Solution

Device Event Category

EventCategory

Device Event Class ID

concatenate("Qualys|","INFOS|",Number)

Device Product

'Qualys'

Device Receipt Time

Date

Device Severity

Severity, (1 = Minimal, 2 = Medium, 3 = Serious, 4 = Critical, 5 =

Urgent)

Device Vendor

'Qualys'

Name

TITLE

Old File Path

_FILE_PATH

Transport Protocol

Protocol

Qualys Practices Mappings to ArcSight ESM Fields

ArcSight ESM Field

Device-Specific Field

Additional Data

ExpltDescription

Agent (Connector) Severity

Very High = Urgent; High = Critical, Serious; Medium = Medium; Low

= Minimal

Destination Address

IPvalue

Destination Host Name

One of (IPname, NetbiosHostName)

Destination Port

Port

Device Custom String 1

Result

Confidential

11

SmartConnector for Qualys QualysGuard File

ArcSight ESM Field

Device-Specific Field

Device Custom String 2

CVEID

Device Custom String 3

Diagnosis

Device Custom String 4

Consequence

Device Custom String 5

Solution

Device Custom String 6

CVSSBaseScore

Device Event Category

EventCategory

Device Event Class ID

concatenate("Qualys|","PRACTICES|",Number)

Device Product

'Qualys'

Device Receipt Time

Date

Device Severity

Severity (1 = Minimal, 2 = Medium, 3 = Serious, 4 = Critical, 5 =

Urgent)

Device Vendor

'Qualys'

Name

TITLE

Old File Path

_FILE_PATH

Transport Protocol

Protocol

Qualys Open Ports Mappings to ArcSight ESM Fields

ArcSight ESM Field

Device-Specific Field

Agent (Connector) Severity

Very High = 5; High = 3,4; Medium = 2; Low = 1

Category Technique

Vulnerability Category

Destination Address

IPvalue

Destination Host Name

One of (IPname, NetbiosHostname)

Device Custom String 1

Result

Device Domain

'Network'

Device Event Class ID

concatenate("Qualys|","Open Port|",Number)

Device Product

'Qualys'

Device Receipt Time

Date

Device Severity

Severity

Device Vendor

'Qualys'

Device Version

Version

Name

'Open Port'

Old File Path

_FILE_PATH

Transport Protocol

Protocol

Qualys Scanner Mappings to ArcSight ESM Fields

ArcSight ESM Field

12

Device-Specific Field

Destination Address

value

Target Host Name

One of (NetbiosHostName, name)

Confidential

Configuration Guide

Qualys Services Mappings to ArcSight ESM Fields

ArcSight ESM Field

Device-Specific Field

Agent (Connector) Severity

Very High= 5; High = 3,4,; Medium = 2; Low = 1

Destination Address

IPvalue

Destination Host Name

One of (IPname, NetbiosHostName)

Destination Port

Port

Device Custom String 1

Result

Device Custom String 3

Diagnosis

Device Custom String 4

Consequence

Device Custom String 5

Solution

Device Domain

'Network'

Device Event Category

EventCategory

Device Event Class ID

concatenate("Qualys|","Services|",Number)

Device Product

'Qualys'

Device Receipt Time

Date

Device Severity

Severity

Device Vendor

'Qualys'

Device Version

Version

Name

Service

Old File Path

_FILE_PATH

Transport Protocol

Protocol

Qualys URIs Mappings to ArcSight ESM Fields

ArcSight ESM Field

Device-Specific Field

Agent (Connector) Severity

Very High= 5; High = 3,4; Medium = 2; Low = 1

Category Technique

Vulnerability Category

Destination Address

IPvalue

Destination Host Name

One of (IPname, NetbiosHostName)

Device Domain

'Network'

Device Event Class ID

concatenate("Qualys|","URI|",One
of(OSName,OSDetected))

Device Product

'Qualys'

Device Receipt Time

Date

Device Severity

Severity

Device Vendor

'Qualys'

Device Version

Version

File Path

One of (OSName, OSDetected)

Name

Operating System; one of (OSName, OSDetected)

Old File Path

_FILE_PATH

Confidential

13

SmartConnector for Qualys QualysGuard File

Qualys Vulnerability Mappings to ArcSight ESM Fields

ArcSight ESM Field

Device-Specific Field

Additional data

ExpltDescription

Agent (Connector) Severity

Very High= 5; High = 3,4,; Medium = 2; Low = 1

Category Technique

Vulnerability Category

Destination Address

IPvalue

Destination Host Name

One of (IPname, NetbiosHostName)

Destination Port

Port

Device Custom String 1

Result

Device Custom String 2

CVEID

Device Custom String 3

Diagnosis

Device Custom String 4

Consequence

Device Custom String 5

Solution

Device Custom String 6

CVSSBaseScore

Device Domain

'Network'

Device Event Category

EventCategory

Device Event Class ID

Concatenate("Qualys", Number, TITLE, Severity, Diagnosis,

Consequence, Solution, CVEID")

Device Product

'Qualys'

Device Receipt Time

Date

Device Severity

Severity

Device Vendor

'Qualys'

Device Version

Version

Name

Both ("Vulnerability:", Number)

Old File Path

_FILE_PATH

Transport Protocol

Protocol

Troubleshooting
Why do I get an 'Invalid credentials' error?
The username and password entered do not match the information in the database. Check to make
sure the information you entered is correct. Usernames and passwords are case sensitive, so make
sure Caps Lock is turned off. If Certificate Authentication is enabled for your account, then several
additional validation checks occur. You will get an "Invalid credentials" error if you do not meet these
conditions:

14

A certificate is present in your browser.

The certificate in your browser is not expired.

The email address in the certificate in your browser matches the email address in your
QualysGuard user account.

The issuer ID in the certificate in your browser matches the issuer ID in the certificate provided to
Qualys for the subscription.

Confidential

Configuration Guide
The exact method of implementing authentication will vary according to which programming language is
used; see the "Sample API Code" section of the QualysGuard API User Guide for details.
My SmartConnector throws an out-of-memory error. What should I do in this case?
The SmartConnector can throw an out-of-memory error when the xml data file is too large. This error is
due to the amount of temporary memory required while attempting to build the document.
If the SmartConnector is running as an application, you can resolve this problem by increasing the java
heap size in $ARCSIGHT_HOME\current\bin\scripts\Connectors.bat or Connectors.sh.
The name of the argument is:
ARCSIGHT_MEM_OPTIONS= -Xms256m -Xmx256m
The max value should be changed.
Or
If the SmartConnector is running as a service, you can resolve this problem by increasing the java heap
size in $ARCSIGHT_HOME\current\user\agent\agent.wrapper.conf. The name of the
property is:
wrapper.java.maxmemory=256
Following are some performance measurements from a development environment indicating conditions
that may throw an out-of-memory error:

Data files larger than 50MB for 256MB java heap size

Data files larger than 125MB for 512MB java heap size

Data files larger than 300MB for 1024MB java heap size

Split the scanning of any large number of assets into multiple smaller chunks so that a set of small XML
reports are created rather than one large XML file.
Communication with the Qualys URL cannot be established. What can I do?
There is a known issue with the connector framework attempting to access the Internet directly, even
when you specify proxy settings during connector setup. This causes communication to the Qualys
URL to fail. To work around this problem, modify the following settings in the
$ARCSIGHT_HOME/current/jre/lib/net.properties file:
https.proxyHost=<hostname>
http.nonProxyHosts=localhost|127.0.0.1|<manager_host>|<manager_ip>
https.nonProxyHosts=localhost|127.0.0.1|<manager_host>|<manager_ip>

Confidential

15