Documentation Nexus IQ Server 1.26

12.7. Component Identification

One of the most important things you can do with regards to understanding the components in your application, is to identify them. What remains unidentified is of obvious concern.

figs/web/app-comp-report-unknown.png

Figure 12.30. Unknown Component


Components can be identified in a number of ways, including:

  • Extensive matching via various, proprietary algorithms
  • Claiming components
  • Establishing proprietary components

In this section, we’ll describe all of these in detail, within the context of identifying components using the Application Composition Report, as well as offer our suggestion for best practices.

12.7.1. Matching Components

When an evaluation is performed, hashes of the components in your application are created. This in many ways is like a fingerprint, which is unique to a component. That fingerprint (hash), is compared back to components known to the IQ Server, which will provide all the available component info. This includes: usage statistics, security vulnerability, and license information.

All of this information can be used as parameters in your policy, which translates to more understanding of the component usage in your organization. That data however, can only be linked based on a matching of hashes, which can be exact or similar, and in some cases, unknown. We discuss these three match types below.

figs/web/app-comp-report-filter-matches.png

Figure 12.31. Filter and Matching Options


Exact
An exact match means that a one-to-one link was found between a component hash in your application, and a component known to the IQ Server. This is the best case scenario with regard to component identification, and most components should fit in this category.
Similar
A similar match is found using various, proprietary matching algorithms. In a way it’s a "best guess" to match a component that you have in your application with a similar one known to the IQ Server. In some cases, multiple matches may be found, and this is where the Similar section of the CIP is important. While the most likely match is used to display any information about a similar matched component, you can see all other matches in this section of the Application Composition Report. An example is displayed in Figure 12.13, “CIP, Similar Section”.
Unknown
There are instances where not even a similar component match can be determined. This should be considered a serious situation, at least one that needs to be investigated. This could be a case of a component being recompiled and modified so that a match is no longer possible.

However, there is a chance that component is something malicious introduced into the application. Either way, an unknown component should prompt an investigation. Of course, if during your investigation, you are able to identify the component, you can claim that component, via the Claim Components section, which we will walk you through in more detail a little bit later. An example is displayed in Figure 12.30, “Unknown Component”.

[Note]

Unknown components will not be displayed in the License tab until they have been claimed.

In addition to the main filters above, you can also control whether all violations for each component will be displayed. By default the summary of violations is shown. This means that only the worst violation for a component will be shown, and the component will only appear once in the list. Choosing All or Waived, will show all violations (including those waived), or only the waived violations, respectively.

[Note]

Changing the Violations filter can result in the components being displayed in the component list more than once.

12.7.2. Managing Proprietary Components

Proprietary components are unique to your organization. In many cases, these are developed by your organization and distributed among the applications you create.

In the Application Composition Report, you can view proprietary components on the Policy Violations tab as shown below. While Proprietary is listed under Filter, the process for matching exact, similar, and unknown components is separate from identifying a component as proprietary. You can have proprietary components that are an exact match, similar match, or unknown match. If you’re trying to determine which of your components are proprietary, a good place to start is to review unknown components.

figs/web/app-comp-report-proprietary.png

Figure 12.32. Proprietary Component


IQ Server uses proprietary component matchers to identify proprietary components when applications are evaluated. Proprietary component matchers are configured in the Organization & Policies area, but you can also add them from within the Application Composition Report. This is especially useful when the report contains unknown components that you know are proprietary.

[Note]

You need to be assigned to a role with "Edit Proprietary Components" permission in order to add proprietary component matchers. The built-in Policy Administrator and Owner roles have this permission.

To add proprietary component matchers:

  1. Click to select a component.
  2. Click the Add Proprietary Component Matchers button.
  3. In the dialog, click the occurrences of the component that are proprietary.
  4. Optionally, add a regular expression to identify proprietary components.
  5. Click Add.
  6. Re-evaluate the binary application or repository to see the component identified as proprietary.
figs/web/app-comp-report-add-matcher.png

Figure 12.33. Add Proprietary Component Matchers


[Tip]

Existing reports are unaffected by additions to the Proprietary Component Matchers list; only after the next evaluation will you see the newly added components identified as proprietary.

For more information about the Proprietary Component Matchers, see Proprietary Component Configuration in the Basic Policy Management chapter.

12.7.3. Claiming a Component

When a component is similar or unknown, yet you are certain the component is recognized by your organization, you can prevent that component from being identified as similar or unknown in future reports. In other words, you can claim the component as your own.

Once claimed, that component will be known to the IQ Server. It will no longer be treated it as similar or unknown, and instead result in an exact match.

figs/web/app-comp-report-claim-component.png

Figure 12.34. Claim a Component


  1. Access an Application Composition Report.
  2. Click the Policy Violations tab, and then click the Unknown or Similar component filter.
  3. Click the row of component you wish to claim in the list - the Component Information Panel is displayed.
  4. Click on the Claim Component section of the CIP .
  5. Enter values for the coordinates of the component.
  6. As an option, enter the coordinates classifier and extension, the Created Date, and/or a Comment. The created date is initialized with the date of the youngest entry in the component to be claimed.
  7. Click the Claim button, to officially stake your claim for the component.

On review of the existing report, as well as those in the future, there is now an indicator that information about the component has been edited. When hovered over, a tooltip is displayed identifying that the component has been claimed.

We refer to this as the edited component tick mark (a small red triangle) on all future scans for this application, as well as any application with a valid Application ID on the IQ Server.

figs/web/app-comp-report-claimed-component.png

Figure 12.35. Claimed Component Indicator


In addition, the Component Info section for the claimed component will now have two new fields, one indicating the Identification Source is Manual, and the other, Identification Comment will include any comments that were entered. While any policy violations will be displayed, the component graph will not.

Finally, if you have made a mistake and wish to revoke the claim on the component or make an edit, click on the Claim Component tab. Then, use the Revoke or Update buttons respectively.

figs/web/app-comp-report-update-claimed-component.png

Figure 12.36. Update or Revoke Claimed Component Indicator


[Tip]

Use the cancel button to undo any changes you made but haven’t saved.