Skip to main content
Version: 0.9

QRadar log sources (WIP)

Reads the log sources configured in IBM QRadar and records, for each host that sends events to it, that the host is covered by the SIEM, through which collectors and protocols, and when QRadar last heard from it. A host QRadar knows is created or enriched as an endpoint, like any other endpoint integration.

Type nameqradar_log_sources
CreatesEndpoints
Runs onA sensor with HTTPS reach to the QRadar console
Presence flagqradar_exists
Field prefixqradar_

How it reads QRadar​

Every call is a read against the QRadar REST API, with the token sent in the SEC header. Nothing is changed in QRadar. Each run reads, whole and paged 500 at a time:

WhatQRadar API path
Log sources/api/config/event_sources/log_source_management/log_sources
Log source types, groups and extensions.../log_source_management/log_source_types, /log_source_groups, /log_source_extensions
Protocol types.../log_source_management/protocol_types
Event collectors/api/config/event_sources/event_collectors
Host profiles, when Enrich from asset model is on/api/asset_model/assets and /api/asset_model/properties

One record per host, not per log source​

A single machine usually owns several log sources, for example a Windows Security Event Log, its WinCollect agent and an IIS source. The sensor folds every log source keyed on the same host into one record, so each host becomes one change entry. A log source is keyed on the hostname it reports (its identifier parameter, or the part after @ in its name), and on its sending IP when it has no hostname. A log source with neither is skipped.

A sending IP used by more than one log source is treated as a relay (a WinCollect destination or a forwarder), not as the host's own address. It is recorded, but never used to match or address the asset.

QRadar's internal log sources (rule engine, asset profiler, audit) describe QRadar itself and are left out unless Include internal log sources is on.

Asset model enrichment​

With Enrich from asset model on, each host is matched to QRadar's own host profile by hostname, FQDN or short name, and by sending IP only when that IP is not a relay. Where several profiles match, the one whose unified name is the host's own, then the least merged one, is used for the operating system, MAC and IP addresses. Every matched profile id is still recorded, so an ambiguous match stays visible. Loopback and link-local addresses are discarded.

Endpoints​

Matching​

A host is matched to the endpoint it already is by, strongest first:

  1. Its QRadar hostname, exactly.
  2. Its short name, in the same DNS domain, on an endpoint whose IP addresses do not contradict it.
  3. Its full hostname in names.
  4. Its short name in the same DNS domain, without the address check.
  5. Its MAC addresses, when the asset model gave any.
  6. Its own IP addresses, when it has any (never a relay IP).

The domain check reads the endpoint's domains, as a directory integration such as Active Directory fills it, or the suffix of any name it holds. An endpoint with no known domain is not excluded by it.

What it writes​

FieldHolds
qradar_hostname, qradar_sending_ip, qradar_sending_ip_is_sharedHow QRadar knows the host, and whether its sending IP is a relay
qradar_status, qradar_enabledHealth over the enabled log sources, worst first (ERROR, WARN, NA, SUCCESS), or DISABLED when none is enabled
qradar_log_source_count, qradar_enabled_log_source_countHow many log sources the host has, and how many are enabled
qradar_log_source_ids, qradar_log_source_names, qradar_log_source_short_names, qradar_log_source_typesThe log sources and their types
qradar_log_source_groups, qradar_protocols, qradar_event_collectors, qradar_extensionsHow the events are collected
qradar_auto_discovered, qradar_wincollectWhether any source was auto-discovered or is WinCollect managed
qradar_average_epsAverage events per second, summed over the host's sources
qradar_last_event_time, qradar_first_creation_dateThe newest event from any source, and the oldest source's creation
qradar_asset_*The matched host profile: ids, match count and method, domain id, unified name, OS, IPs, MACs, products, vulnerability count and risk score
qradar_log_source_detailsThe full log source records, as JSON

It also writes the shared fields names (short name), fqdn and domains (added to what the endpoint holds), mac (added), os, os_vendor, private_ip and updated_at. type is set only when the operating system says what the device is. Without asset model enrichment there is no OS, MAC or profile data, and private_ip comes from the sending IP only when that is not a relay.

The newest event time is the endpoint's last-seen time and is decommissioning evidence. The oldest log source's creation date is its first-seen time.

Silent log sources are dropped, not imported

A host whose newest event is older than Ignore if host is offline (180 days by default) is a stale log source definition, not a live machine, and is skipped so it does not recreate decommissioned assets. A host that has never sent an event is not skipped.

Requirements​

Network access​

FromToProtocolPort
The sensor running the integrationThe QRadar console named in URLHTTPS over TCP443, unless the URL names another

If the console presents a certificate the sensor host does not trust, install its CA on the host in preference to enabling Ignore SSL: the token is sent on every request.

Access in QRadar​

NeedWhy
An authorised service tokenSent as the SEC header on every call
Read access to the log source management and event collector paths aboveEvery run reads them in full
Read access to the asset model paths aboveOnly when Enrich from asset model is on

Give the integration a token of its own, under a security profile that covers the hosts it should see, rather than an administrator's.

TODO

Confirm the least-privileged QRadar user role and capabilities that can read these paths.

In this deployment​

NeedWhy
A registered, healthy sensor with reach to the consoleThe integration runs on a sensor, on the platform's schedule, see Sensors

Configuration​

FieldRequiredNotes
NameYesLabel for this instance
URLYesQRadar console, e.g. https://qradar.example.com
TokenYesAuthorised service token
CookiesNoExtra cookies added to requests
Proxy settingsNohttp://host:port
Ignore SSLNo, on by defaultSkips certificate validation
Enrich from asset modelNo, on by defaultReads OS, MAC and IP details from the QRadar asset model
Include internal log sourcesNo, off by defaultAlso imports QRadar's own log sources as an asset
SensorYesSensor that will run the integration

Its scan template adds nothing to the shared model. Ignore if host is offline defaults to 180 days and decides which silent hosts are dropped, as above.

See also​