Documentation Index

Fetch the complete documentation index at: https://help.nucleussec.com/llms.txt

Use this file to discover all available pages before exploring further.

Software

Prev Next

Uploading Software Inventory

The FlexConnect Framework can be used to upload software inventory information (such as the installed software and version). Software inventory information can be uploaded by adding an informational finding to an existing scan file, or by creating a new scan file that contains this finding. These findings can be included with a normal FlexConnect upload.

The finding must satisfy the following criteria to be successfully parsed in Nucleus:

Field Name

Value

finding_number

generic-software

finding_output

A new-line delimited list of installed software where each software line includes a name and version delimited by a ‘ -  with spaces on each side’ (dash)

If no version is specified, the entire line will be used as the software name.

finding_severity

Informational. This must be set to an informational severity finding.

Example JSON

JSONMarkup

{
    "nucleus_import_version": 1,
    "scan_tool": "Software Checker",
    "scan_type": "Host",
    "assets": [
        {
            "host_name": "Host1",
            "findings": [
                {
                    "finding_number": "generic-software",
                    "finding_name": "Software List",
                    "finding_severity": "Informational",
                    "finding_output": "Software1 - Version1\nSoftware2 - Version2\nSoftware3 - Version3"
                },
                {
                    "finding_number": "generic-software",
                    "finding_name": "Software List",
                    "finding_severity": "Informational",
                    "finding_output": "Software3 - Version1"
                }
            ]
        },
        {
            "host_name": "Host2",
            "findings": [
                {
                    "finding_number": "generic-software",
                    "finding_name": "Software List",
                    "finding_severity": "Informational",
                    "finding_output": "Software2 - Version3\nSoftware3 - Version3\nSoftware4 - Version4"
                }
            ]
        }
    ]
}

Example XML

JSONMarkup

<nucleusCustomScan>
  <nucleus_import_version>1</nucleus_import_version>
  <scan_tool>Software Checker</scan_tool>
  <scan_type>Host</scan_type>
  <assets>
    <asset>
        <host_name>Host3</host_name>
        <findings>
            <finding>
                <finding_number>generic-software</finding_number>
                <finding_name>Software List</finding_name>
                <finding_severity>Informational</finding_severity>
                <finding_output>Software7 - Version1
                Software8 - Version2
                Software9 - Version3</finding_output>
            </finding>
            <finding>
                <finding_number>generic-software</finding_number>
                <finding_name>Software List</finding_name>
                <finding_severity>Informational</finding_severity>
                <finding_output>Software3 - Version1</finding_output>
            </finding>
        </findings>
    </asset>
    <asset>
        <host_name>Host4</host_name>
        <findings>
            <finding>
                <finding_number>generic-software</finding_number>
                <finding_name>Software List</finding_name>
                <finding_severity>Informational</finding_severity>
                <finding_output>Software10 - Version10
                Software11 - Version3
                Software12 - Version4</finding_output>
            </finding>
        </findings>
    </asset>
  </assets>
</nucleusCustomScan>

Example CSV

Markup

nucleus_import_version,scan_tool,scan_type,host_name,finding_number,finding_name,finding_severity,finding_output
1,Software Checker,Host,Host1,generic-software,Software List,Informational,"Software1 - Version1
Software2 - Version2
Software3 - Version3"
1,Software Checker,Host,Host2,generic-software,Software List,Informational,"Software2 - Version3
Software3 - Version3
Software4 - Version4"
1,Windows WMI,Host,Host1,generic-software,List of Software,Informational,Software3 - Version1