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 GÉANT, use the single sign-on login (SSO):

  1. Open WhiteSource Mend login at http://whitesourcemend.software.geant.org/.
  2. Click Sign in with SSO.

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

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

For more information on accounts management and customisation of WhiteSource Mend and products visibility, see Re: MANUAL: Accessing WhiteSource Mend and visibility levels. (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 licences and interpretation of the provided data for GÉANT.

The dashboard in WhiteSource Mend can be at the organisation (GÉANT), Product or Project level. A detailed explanation of the terms Products, Projects, and Organisations in WhiteSource 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 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:

...

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 WhiteSource 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)

...

  • 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)

...

  • 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.

The Project page displays detailed information about a specific project within a previously selected product. It can be accessed from the Projects menu.

Interpreting Risk Report

The Risk Report is a tool that provides a view of all aspects of open-source libraries concerning their licences, 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 organisational (i.e., GÉANT), but you can select any individual product and/or project.
  3. Click Apply.

Understanding the Report Data

The report contains 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 (GÉANT, product or project) with the overall average statistics calculated for WhiteSource Mend clients. Includes the following three charts: Vulnerable Libraries, Policy Violating Libraries, Outdated Libraries
  2. Security - This panel displays the vulnerability score (based on the highest severity vulnerability), the number of vulnerable components out of total components, severity distribution, ageing security vulnerabilities, 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 organisation (or product), showing which licences are used and how many libraries are associated with each licence.
  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.

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:

...

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 WhiteSourceMend.

Customising visibility

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

By default, anyone who applies to WhiteSource Mend can see the content of all non-restricted 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 WhiteSource 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.