Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Log in

WhiteSource Mend software provides several methods for user login. In GEANTGÉANT, use the single sign-on login (SSO):

  1. Open WhiteSource Mend login at httpsat http://app-eu.whitesourcesoftware.com/mend.software.geant.org.
  2. Click Sign in with SSO.

  3. Enter your GEANT GÉANT email address to be forwarded to the GEANT GÉANT login page.

  4. Log in with your identity provider as you would for other GEANT GÉANT services.
  5. Your GEANT WhiteSource GÉANT Mend Home Page opens.

...

  1. .

For more information on accounts management and customisation of WhiteSource Mend and products visibility, see Re: MANUAL: Accessing WhiteSource Mend and visibility levels (THIS PAGE SHOULD BE MOVED!).note this page is stored in a private space and it can be accessed only by GN4-3 members)

Dashboard (key information in

...

Mend user interface)

Many things are shown on the WhiteSource Mend dashboard. To understand them, read the following text which is focused on licenses licences and interpretation of the provided data for GEANTGÉANT.

The dashboard in WhiteSource Mend can be at the level of organization organisation (GEANTGÉANT), Product or Project level. A detailed explanation of the terms Products, Projects, and Organizations Organisations in WS Mend is here. In a nutshell: your team is working on a WhiteSource Mend 'product' which may consist of several related pieces of software, which are in WhiteSource Mend called 'projects'.

The dashboard at the organization organisation level is WhiteSource Mend Home Page; at the product level, it is Product Page, and at the project level, Project Page. Regardless of the level, the dashboard contains the following key information:

...

  • Libraries alert types:
    • New Versions - The total count of outdated libraries (counts the libraries that have newer versions)
    • Multiple Versions - Multiple versions of the same library are in use
    • Multiple Licenses Licences - An alert is triggered is triggered for any library that has more than one license. licence
  • Security alerts:
    • Per-Library Alerts - The total number of libraries with vulnerability alerts (for example,  the the alert count for a Product with two Projects where each features an alert for the same library will be "one" and will be displayed in one row noting two project occurrences.)
    • Per-Vulnerability Alerts - The total number of vulnerability alerts 
  • The Libraries table shows detailed information about the product’s (project's) libraries (components).  The following attributes are listed:
    • Library : - Clicking the library name redirects you to the specific library page.
    • Licenses: Licences - The licenses licences that are associated with the library.
    • Occurrences : - The number of occurrences of the library per project.

The Library table in the header has a link to the Inventory Report. This report is a tabular view of detailed information about open-source libraries. The Inventory Report provides the following columns for each library:

  • Library Name - The standard name of the library

  • Type - Indicates whether the library is a source library

  • Description - Short functional description of the library

  • Licences - Licences associated with the library

  • Match Type - One of the following:

    • Exact match - The library was matched by SHA-1 checksum

    • Best match - Source files were matched by SHA-1 checksum; the library was identified by the found source by best match

    • Filename match - Library could not be matched by SHA-1 checksum but was matched the filename

    • Suspected match - Library match is expected and will be updated with the exact match (in the near future, supposedly after the Mend database is updated)

  • Occurrences - Number of all instances in which the library is used in any project in the organisation (you can click the details link to see the name of the project(s) and their associated product names)

Detailed information about the licences (Licence DistributionAnalysis)

This section provides an overview of the license licence distribution of the organization organisation (or product, project), showing which licences are used and how many libraries are associated with each licenselicence.   The distribution of licences is shown in the pie chart. The following information is displayed for each licence:

  • Name - Name of the licence
  • Occurrences - Number of occurrences by libraries
  • Copyright - Copyright Risk Score which is a measurement of the risk related to copyright (in general terms, regardless of the product or project licence)

The Project dashboard within this section has a link View in Due Diligence Report. This report is a tabular view of detailed information about all detected licences. TheDue Diligence Reportprovides the following columns of information:

  • License - The name of the

...

  • licence for the library

  • License Type - The type of licence (Open Source, Closed Source, Unknown)

  • Risk - The licence copyright risk score (for details, see Risk Score Attribution)

  • Library - The name of the open-source library (click the library name to be forwarded to its Library Details page)

  • License Reference - Includes an indication as to where the licence was found

  • Copyright - The range of years for the library's copyright

  • Homepage - Link to the homepage of the library

  • Author - The name of the author of the library

  • Project - The project where the library is used

  • Product - The product where the library is used

Finding your product and projects

The Product page displays detailed information about a specific product (the result of a product scan for a specific version). The product page for a product is accessed from the Products menu item of the main menu.

The Project page displays detailed information about a specific project within a previously selected product. It can be accessed from the Projects menu item in the main menu.Significant tables and charts and how to find, customise and interpret them...

Libraries and dependencies

Licenses

Interpreting WS information about licences

The difference in interpreting the presence of a problematic library when assessing the situation vs exploring license compatibility and compliance options vs checking compliance with the established product's licence

same policy/licence across projects in the product vs differentiated project policies

Interpreting Risk

...

Report

The Risk Report is a tool that provides a view of all aspects of open-source libraries concerning their licenseslicences, security, quality and compliance.

Creating the Report

  1. The report is available from the "Reports" menu. 
  2. Define the scope for which the report should be created. The defaults scope is Organizational (GEANTorganisational (i.e., GÉANT), or but you can select any individual product and/or project.
  3. Click ApplyClick Apply.

Understanding the Report Data

The report contains a number of several panels and tables displaying risk-related information. The Risk Report has the following sections:

  1. How do we compare? - This section compares the results of measuring the level of risk and compliance of the selected range (GEANTGÉANT, product or project) with the overall average statistics calculated for WS Mend clients. Includes the following three charts: Vulnerable Libraries, Policy Violating Libraries, Outdated Libraries.
  2. Security - This panel displays the vulnerability score (base based on the highest severity vulnerability), the number of vulnerable components out of total components, severity distribution, aging ageing security vulnerabilities, license licence risk distribution, outdated components out of total components and libraries with multiple versions.
  3. License Risks and Compliance - This panel provides an overview of the License Distribution of the organization organisation (or product), showing which licenses licences are used and how many libraries are associated with each licenselicence.
  4. Quality - This panel provides information about any outdated libraries
  5. Additional Risk Information - Contains detailed tables with various component-level breakdowns.

Exporting the Report

Click Export to PDF at the top right of the report and export the Risk report as a PDF file.

Customising visibility

Interpreting License Compatibility Report

The License Compatibility Report provides information on the compatibility of libraries with different software licences distributed together in the same product or project. 

Creating the Report

  1. The report is available from the Reports menu. 
  2. Select the scope for which the report should be created - open the dropdown menu next to the report name and select the product or project for which you want the report

  3. Click Apply and wait for the data to load into the report preview table.

Understanding the Report Data

The report table provides the following columns:

  • Library - The name of the open-source library that has a licence conflict

  • Licence - The library's licence

  • Incompatible with Licence - The licence to which the library's licence is incompatible

  • Incompatibility Type - Displays the type of licence for which there is an actual, suspected or potential incompatibility:

    • Incompatible - The library’s licence is fundamentally incompatible and cannot be used under any circumstance

    • Suspected - A suspected incompatibility is displayed when the licence compatibility is dependent on the library hierarchy within the Product or Project, and the library’s hierarchy is unknown

    • Potential - The library being evaluated is licenced under multiple licences, meaning that you can choose under which licence the library will be licensed

  • Incompatibility Occurrences - Displays the number of libraries that include the suspected or actual incompatible licence. When the scope is a product, it also displays the number of projects that are impacted by the incompatibility

After a specific row in the table is clicked on, a lower table shows all libraries with the licenses that are incompatible with the licence of the selected one. This table includes the names of conflicting libraries and projects in which they are located.

The easiest way to check the compatibility of libraries with your project licence is to select a library with the same license. If you can't find one, you need to add a library with that licence to your product or project and rescan it with Mend.

Customising visibility

The GÉANT Mend The GEANT WhiteSource admins can always see all scanned GEANT GÉANT products.

By default, anyone who applies to WhiteSource Mend can see the content of all non-restricted GEANT GÉANT products and projects in WhiteSourceMend. It is possible to restrict read permissions to scan results for specific products and projects. You can contact the GEANT WhiteSource Mend support to get access to a specific project that has limited visibility or to restrict the permissions for a specified product or project.

You may also ask the GEANT Mend support for the Product Administrator role to manage the access to your project, after which the responsibility of the entire product will be on you.