SolarWinds Web Help Desk (WHD) Integration¶

Faraday's SolarWinds integration allows you to export confirmed vulnerabilities to Web Help Desk (WHD) from SolarWinds as incidents. Vulnerabilities are sent using the WHD Incident table with configurable templates for incident description formatting.

Availability: Commercial feature (requires licensed Faraday instance).

Verified against: Faraday Server v5.19.0 codebase, wiki doc dated 2023-01-26.

Overview¶

Prerequisites¶

• A running Faraday Server instance (commercial edition)
• A SolarWinds Web Help Desk instance
• A WHD API Key for authentication
• Network connectivity between Faraday Server and WHD

Step 1: Configure Web Help Desk Settings in Faraday¶

Access Settings¶

1. Log in to the Faraday Web UI.
2. Click your username at the top-right and select Settings.
3. Navigate to Ticketing Tools and select Web Help Desk / SolarWinds.

Configure Connection¶

Select Template¶

Select a template from the dropdown. A default template is pre-loaded in your Faraday instance.

Step 2: Configure or Customize the Template¶

Templates are stored at:

/home/faraday/.faraday/integrations_templates/

Default Template¶

{# This is a Template for Faraday SolarWinds Integration #}
{# Pre-Flight Adjustments #}
{% set issuetracker_config = 'solar winds' %}
{% set http_size_config = 4096 %}
{% if 'med' in vuln.severity %}
{% set corrected_severity = 'Medium' %}
{% else %}
{% set corrected_severity = vuln.severity %}
{% endif %}

{# Issue template structure #}
{% if 'VulnerabilityWeb' in vuln.type %}
# [{{ corrected_severity | capitalize }}] {{ vuln.name }} - ({{ vuln.path }})
{% else %}
# [{{ corrected_severity | capitalize }}] {{ vuln.name }}
{% endif %}

## Description
{{ vuln.desc }}

#### This issue has been rated as: `{{ corrected_severity | capitalize }}`

Affected Asset: {{ vuln.target }}
{% if vuln.website %}
Affected URL: {{ vuln.website }}{{ vuln.path }}
{% endif %}

{% if vuln.hostnames %}
#### Hostnames
{% for hostname in vuln.hostnames %}
- {{ hostname }}
{% endfor %}
{% endif %}

## Recommendations
{{ vuln.resolution }}
{% for ref in vuln.refs %}
- {{ ref }}
{% endfor %}

{% if vuln.easeofresolution %}
#### Estimated ease of resolution
{{ vuln.easeofresolution | capitalize }}
{% endif %}

### Technical Details
{% if vuln.data %}
#### Proof of Concept
{{ vuln.data }}
{% endif %}

{% if vuln.request %}
#### Request
{{ vuln.request | truncate(http_size_config, False, '...', 0) }}
{% endif %}

{% if vuln.response %}
#### Response
{{ vuln.response | truncate(http_size_config, False, '...', 0) }}
{% endif %}

## Issue [{{ vuln.id }}] {{ vuln.name }} [{{ vuln.status }}]
{% for key, value in vuln.issuetracker_json.items() %}
{% if issuetracker_config in key %}
This issue has already been reported in this platform:
- {{ key | capitalize }}
{% for line in value %}
- Issue: {{ line.url }}
{% endfor %}
{% endif %}
source: created by {{ vuln.owner or "faraday" }} using {{ vuln.tool }} - {{ vuln.external_id }} - {{ vuln.date }}
{% endfor %}
{# end of file #}

Template Configuration Directives¶

Template Variables¶

The following vulnerability fields are available via the vuln object:

Step 3: Export Vulnerabilities to Web Help Desk¶

1. In the Faraday Web UI, go to Manage > Vulns.
2. Select one or more confirmed vulnerabilities.
3. Click Tools (context menu) and select Web Help Desk from Solar Winds.
4. A dialog appears with two options:
5. Use default data: Uses the URL and API Key saved in Settings.
6. Override credentials: Check the override box and enter custom WHD URL and API Key for this export.
7. Click OK to send the vulnerabilities.

Tracking Exported Vulnerabilities¶

• Add the issuetracker column to the vulnerability table to see links to created WHD incidents.
• Click the link to open the incident directly in Web Help Desk.
• The issuetracker_json field provides structured details (incident URL, ID) and can be used in Executive Reports.

Permissions¶

Role-Based Access¶

Data Model¶

Vulnerability Fields¶

Note: Web Help Desk does not have a dedicated UserToken scope. Authentication is handled via API Key in the configuration settings.

Troubleshooting¶

Changelog¶

Source References¶

• Wiki source: repos/faraday-wiki/docs/integration-solarwinds.md
• Permission definitions: faraday/server/utils/permissions.py — UNIT_WEB_HELP_DESK
• Configuration model: faraday/server/models.py (line ~3641)
• VulnerabilityGeneric model: faraday/server/models.py (line ~1431) — issuetracker
• Vulnerability schema: faraday/server/api/modules/vulns_base.py (line ~299) — issuetracker serialization
• Custom roles migration: faraday/migrations/versions/a29d52685b58_custom_roles.py — permission unit ID 18