Skip to main content

Sonatype Nexus IQ

Sonatype Nexus IQ is an application security tool that scans your applications and components to identify policy violations and security vulnerabilities. You can bring application, component, policy violation, remediation, and security issue data from Sonatype Nexus IQ into Brinqa to construct a unified view of your attack surface, thus strengthening your cybersecurity posture.

This document details the information you must provide for the connector to authenticate with Sonatype Nexus IQ and how to obtain that information from Sonatype. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select Sonatype Nexus IQ from the Connector drop-down. You must provide the following information to authenticate Sonatype Nexus IQ with Brinqa:

  • Nexus server: Your organization's Nexus server URL. The default format is https://<ServerName>/.

  • Username and Password: The username and password associated with the Sonatype Nexus IQ user account, which must have permissions to access the Sonatype API and return data.

    info

    The Sonatype Nexus IQ user must have the View IQ Elements permission to access and retrieve data from the Sonatype Nexus IQ API. For additional information, see Sonatype documentation.

Additional settings

The Sonatype Nexus IQ connector contains an additional option for specific configuration:

  • Skip certificate verification: Select this option to allow for untrusted certificates.

Types of data to retrieve

The Sonatype Nexus IQ connector can retrieve the following types of data from the Sonatype Nexus IQ REST API:

Table 1: Data retrieved from Sonatype Nexus IQ

Connector ObjectRequiredMaps to Data Model
ApplicationYesApplication
ComponentYesPackage
Policy ViolationYesViolation
Policy Violation DefinitionYesViolation Definition
RemediationYesSolution
Security IssueYesVulnerability
Security Issue DefinitionYesVulnerability Definition
info

For detailed steps on how to view the data retrieved from Sonatype Nexus IQ in the Brinqa Platform, see How to view your data.

Attribute mappings

Expand the sections below to view the mappings between the source and the Brinqa data model attributes.

Application

Table 2: Application attribute mappings

Source Field NameMaps to Attribute
CONTACTLocal variable
NAMEname
ORGANIZATION_IDLocal variable
PUBLIC_IDLocal variable
SYS_IDuid
Component

Table 3: Component attribute mappings

Source Field NameMaps to Attribute
APPLICATIONStargets
ARTIFACT_IDLocal variable
CLASSIFIERLocal variable
COORDINATESLocal variable
DECLARED_LICENSESLocal variable
EXTLocal variable
FILE_NAMEfileName
FILE_PATHSLocal variable
FORMATLocal variable
GROUP_IDLocal variable
NAMEname
OBSERVED_LICENSESLocal variable
SECURITY_ISSUESLocal variable
SYS_IDuid
VERSIONcurrent version
Policy Violation

Table 4: Policy Violation attribute mappings

Source Field NameMaps to Attribute
APPLICATION_IDappId, targets
APPLICATION_NAMEtargets
COMPONENT_IDLocal variable
COMPONENT_NAMELocal variable
CONSTRAINTLocal variable
POLICY_IDtype
REASONSLocal variable
REPORT_URLLocal variable
STAGELocal variable
THREAT_LEVELLocal variable
UIDuid
Policy Violation Definition

Table 5: Policy Violation Definition attribute mappings

Source Field NameMaps to Attribute
COMPONENT_IDLocal variable
COMPONENT_NAMELocal variable
CONSTRAINTLocal variable
POLICY_IDuid
POLICY_NAMEname
POLICY_TYPEcategory
REASONSLocal variable
REPORT_URLLocal variable
STAGELocal variable
THREAT_LEVELLocal variable
Remediation

Table 6: Remediation attribute mappings

Source Field NameMaps to Attribute
COMPONENT_IDLocal variable
SYS_IDuid
VERSION_CHANGESLocal variable
Security Issue

Table 7: Security Issue attribute mappings

Source Field NameMaps to Attribute
APPLICATION_IDAppId, targets
COMPONENT_IDtargets
COMPONENT_NAME(component)Local variable
REFtype
SOURCELocal variable
STAGE(report)Local variable
STATUSstatus(normalized), sourceStatus, statusCategory
SYS_IDuid
Security Issue Definition

Table 8: Security Issue Definition attribute mappings

Source Field NameMaps to Attribute
COMPONENT_NAME(component)Local variable
REFreferences
SEVERITYseverity, severityScore, sourceSeverity
SOURCELocal variable
STAGE(report)Local variable
THREAT_CATEGORYLocal variable
URLurl
info

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Operation options

The Sonatype Nexus IQ connector supports the following operation options. See connector operation options for information about how to apply them.

Table 9: Sonatype Nexus IQ connector operation options

Connector ObjectOptionAll Possible ValuesDescriptionExample
Component,
Remediation,
Security Issue
applicationIdAny Sonatype Nexus IQ application IDA comma-separated list of application IDs. Return only the data with the specified application IDs.Key: applicationId Value: c1a0586b13,b2b0526b23. This key and value combination only retrieves data with the specified application IDs.
note

The option keys and values are case-sensitive as they are shown in this documentation.

APIs

The Sonatype Nexus IQ connector uses the Sonatype REST API v2. Specifically, it uses the following endpoints:

Table 10: Sonatype Nexus IQ REST API Endpoints

Connector ObjectAPI Endpoints
ApplicationGET /api/v2/applications
ComponentGET /api/v2/reports/applications/{applicationId}
GET /api/v2/reports/applications/{reportDataUrl}
Policy Violation,
Policy Violation Definition
GET /api/v2/policies
GET /api/v2/policyViolations
RemediationGET /api/v2/reports/applications/{applicationId}
GET /api/v2/reports/applications/{reportDataUrl}
Security Issue,
Security Issue Definition
GET /api/v2/reports/applications/{applicationId}
GET /api/v2/reports/applications/{reportDataUrl}

Changelog

The Sonatype Nexus IQ connector has undergone the following changes:

3.0.0