Lifecycle Quick Start Guide

IQ Server | Reading time: 6 minutes

Is this article helpful?

Use this guide to get IQ Server up and running for the purpose of trying out associated Nexus Lifecycle or Lifecycle Foundation functionality before installing these solutions in your development environment.

To dive into Nexus Lifecycle further, check out our IQ Server technical guides, courses, and help documentation.

Step 1: Installing & Starting IQ Server

Check out the video below for a quick demonstration, and then keep reading to learn more.

 

Installing the IQ server is done in a few easy steps - pick a location, download the archived server, and unpack the contents. Since we’re not focused on mimicking a production experience, most laptop and desktop configurations should run IQ Server with no problem. If you are looking to plan for the future, be sure to review the Installation Requirements.

Both Nexus Lifecycle and Lifecycle Foundation require a license to experience the functionality described in this guide. If you are looking to try or purchase Nexus Lifecycle, contact us and we’ll be happy to assist.

NOTE: A Lifecycle Foundation license provides a subset of Nexus Lifecycle functionality designed to support a focus on visibility and analysis of open source risk.

  1. Create an installation directory in your desired location.
  2. Download the latest version of IQ Server to the installation directory.
  3. Extract the tar.gz or .zip file.
  4. Using a command line interface, switch to the nexus-iq-server bundle directory in your installation directory e.g. nexus-iq-server-x.xx.x-xx-bundle.
  5. Run one of the following commands to start IQ Server:
    • Linux or Mac: ./demo.sh
    • Windows: demo.bat
  6. Open IQ Server in a browser using the default URL: http://localhost:8070
  7. Log in using the default Administrator account:
    • Username: admin
    • Password: admin123
  8. Change your password using the Admin menu.

  9. Using the System Preferences menu, install the required Lifecycle license supplied to you by the Sonatype Support team.

NOTE: IQ Server needs access to an external data service to perform evaluations, which may be blocked in your internal environment. For a workaround, see Running IQ Server Behind an HTTP Proxy Server.

Step 2: Evaluating Applications

Check out the video below for a quick demonstration, and then keep reading to learn more.

 

After you install and start the IQ Server, you are ready to evaluate applications. We offer several ways to evaluate applications, for example via our CLI, or one of our many other integrations. For this example, we’ll be evaluating an application through the User Interface (UI). Doing so will transfer the bits to your IQ server. If you are working on a slower connection, or over a VPN, this means longer analysis times.

If you need a sample application, download the WebGoat project at https://github.com/WebGoat/WebGoat/releases.

For this guide, we suggest using the provided ‘sandbox’ organization and application populated with sample data to get started learning the concepts.

To evaluate an application:

  1. Click Organization & Policies from the top toolbar and then select the sandbox application from the sidebar. The file you evaluate is associated with this application.

  2. Go to the Actions menu, and click Evaluate Binary.

  3. In the Evaluate a Binary dialog:

    • Click Choose File or Browse, select the file to evaluate, and click Open.
    • Select any stage to associate with the evaluation, for example Build.
    • Click No to prevent sending notifications of policy violations as defined in the policy’s configuration settings.
    • Click Upload to begin evaluating the selected application.

When the evaluation is complete, click View Report to open the Application Composition Report for the evaluated application.

Step 3: Reviewing Results

Check out the video below for a quick demonstration, and then keep reading to learn more.

 

Once evaluated, the results of a binary evaluation are displayed in the Application Composition Report, which you can always access by selecting Reporting from the top toolbar.

The Application Composition Report is made up of several different sections:

  • The Summary section is at the top of the main content area. It shows you the report title, date, and high-level statistics on violation counts, identified component counts, and grandfathered violation counts.
  • The Policy Violations table shows a list of all components found during the scan of the application, with components ordered by worst policy violation. You can sort the table by threat level, policy name, and component name, and filter via the policy name and the component name.
  • The Filter sidebar displays to the left of the Summary and Policy Violations table. It includes controls for violation aggregation and lets you filter by proprietary, component match state, violation state, policy type, and policy threat level.
  • The Vulnerabilities List can be accessed via the Options menu. This shows you an overview of all the security vulnerabilities that triggered policy violations. Detailed information on a given vulnerability can be accessed by clicking the vulnerability ID, which links to the corresponding Vulnerability Lookup page.

Step 4: Investigating & Remediating Violations

Check out the video below for a quick demonstration, and then keep reading to learn more.

 

In the Application Composition Report, you can drill down to learn specific details about a violation. From the Policy Violation table, click an individual component to open the Component Information Panel (CIP).

To get you started using the CIP, take a look at these sections:

  • Component Info - In the graph, move the vertical bar to learn the differences between versions of a component.
  • Policy - Click the Waive button to force IQ Server to ignore a policy violation.
  • Licenses - Track your research about a particular license and even override one.
  • Vulnerabilities - Click the Info icon for a thorough explanation of a component’s vulnerability and a recommended action.

When investigation is complete, it’s time to begin remediation. In general, policy resolution can be achieved by completing one of the following tasks:

  • Upgrade to a non-vulnerable version of the same component. This option is most recommended because it is generally the easiest path to resolution and reducing your risk.
  • Select a new component that does not contain the violation. If you’re not able to upgrade your component, the next step is to select a similar component without the violation. This option involves research, because you’re looking for a replacement component that provides the same functionality while ensuring it’s not exploitable.
  • Request a waiver for the policy violation. If you can’t upgrade or migrate, the next option is to request a waiver. Send a waiver request to the Project Owner with enough information for a determination to be made. Applying a waiver assumes a certain amount of technical debt, and does not fix the violation. Because of this, it should be used judiciously.

Additional Resources

Visit IQ Server 101: Organizational Policies for an interactive course on policies inside IQ Server.

Talk to Us

Have more questions or comments? Learn more at help.sonatype.com, join us in the Sonatype Community, and view our course catalog at learn.sonatype.com.

And visit my.sonatype.com for all things Sonatype.