FossID Documentation

Dependency Analysis Installation

FossID-DA

The FossID Workbench default installation comes prepared with the FossID-DA tool. The binary is placed in /fossid/bin folder.

The FossID Dependency Analysis tool requires FossID Shinobi running as service. To enable the service to start at boot and start the service please run the following command:

sudo systemctl enable --now fossid-shinobi.service

For more details about FossID-DA please see the dedicated documentation section here

OSS Review Toolkit

FossID Workbench can also be configured to use an add-on called ORT (OSS Review Toolkit) to scan a project for dependencies. ORT is licensed under the Apache 2.0 License and is available at http://oss-review-toolkit.org/. FossID maintains a stable fork at https://github.com/fossid-ab/fossid-ort along with some additional build and installation scripts intended to make the installation of ORT simpler.

A binary package is also available in the FossID delivery site but note that this is not the latest build you could get from an up-to-date source code.

The recommended installation path is the binary package provided in the FossID Delivery Portal which requires minimum configuration.

Requirements

Running ORT

  • Linux OS:
    • Debian 11
    • Debian 12
    • Ubuntu 20.04
    • Ubuntu 22.04
    • Ubuntu 24.04
    • RedHat Enterprise Linux 8 and 9
    • RedHat Enterprise Linux Server 8 and 9
  • FossID v21.2.3 or later
  • Package Managers, such as npm, Gradle, or pip, depending on what projects you are planning to analyze. For a successful dependency analysis, you need all the package managers the project being analyzed requires in order to be built.

Building ORT

  • Linux OS
  • Docker

Install and configure ORT on FossID server from packages

Download the rpm or deb package from your delivery portal. If you’re using a proxy for accessing the internet, please follow first, the instructions from the section: Enabling proxy for maven.

On a Debian/Ubuntu server, run:

sudo apt install ./fossid-ort-22.2.amd64.deb -y

On a RedHat server, run:

sudo yum install ./fossid-ort-22.2.x86_64.rpm -y

Note the actual package file name may differ.

ORT will be installed to /fossid/lib/ort. Additional dependencies will be installed by Maven package manager.

For updates, the /fossid/etc/fossid.conf option webapp_dependency_analysis needs to be updated:

webapp_dependency_analysis_tool="sudo -u ort /fossid/lib/ort/bin/ort"

Enabling proxy for maven.

The maven package is required to be installed previous to the installation of the fossid-ort package. If you’ve already tried installing fossid-ort, please remove it.

For Debian/Ubuntu servers:

sudo apt install maven -y

For RedHat server:

sudo yum install maven -y

Next configure the proxy settings, system-wide:

Identify the settings.xml file, usually in /usr/share/maven/conf/ directory, find the section <proxies> and add the proxy configuration:

<proxy>
  <id>{proxy name identifier - optional}</id>
  <active>true</active>
  <protocol>{https or http}</protocol>
  <username>{proxy user}</username>
  <password>{proxy password}</password>
  <host>{proxy host here}</host>
  <port>{port here}</port>
  <nonProxyHosts>{local.net or some.host.com}</nonProxyHosts>
</proxy>

Build fossid-ort from source code

Note: If you’ve decided to download and install the binary build from FossID Delivery portal, skip this section.

The repository is available at https://github.com/fossid-ab/fossid-ort.

Download the repository and extract it to a computer where you are planning to build it.

The build instructions are in the fossid-install/README.md and also available online at https://github.com/fossid-ab/fossid-ort/tree/main/fossid-install.

Follow the build instructions to build the source and get the binaries. When the binaries are built, continue to Section 2 of this document.

ORT built from the source code

If you built ORT using Docker, you should have a folder with the following structure in the ort/build directory:

~/ort/build$ tree
.
└── ort
    ├── bin
    │   ├── import_proxy_certs.sh
    │   ├── ort
    │   ├── ort.bat
    │   └── set_gradle_proxy.sh
    └── lib
        ├── analyzer-0.1.0-SNAPSHOT.jar
        ├── animal-sniffer-annotations-1.14.jar
        ...

Assuming FossID Workbench is installed to /fossid directory on your Workbench server, copy the ort folder to /fossid/lib/. If the /fossid/lib does not exist, create it.

If you built ORT using gradle, the ort directory to copy will be in the <repository root>/cli/build/install.

NOTE:

The fossid-install folder mentioned above contains scripts for some Linux distributions that automate the steps below.

Create ort user

First, create the home directory for the ort user.

sudo mkdir /fossid/uploads/ort

Create the user, the command checks if the user alredy exists, adds it to the www-data group, also sets permissions for the home and uploads directory.

getent group www-data >/dev/null || sudo groupadd -r www-data
getent passwd ort >/dev/null || \
    sudo useradd -r -g www-data -d /fossid/uploads/ort -s /usr/sbin/nologin \
            -c "account generated by fossid-release for dep-analysis" ort

Change permissions to enable FossID to run ORT

ORT will need to be run by the web server. In the instructions below, we assume the user group account under which the web server (the php service, to be precise) is running is the www-data. If it is a different user, make sure you update the commands you run respectively.

Change the owner of /fossid/lib/ort to www-data:

sudo chown -R ort:www-data /fossid/lib/ort

Change the permission of the ort script to be executable (if it is not):

sudo chmod +x /fossid/lib/ort/bin/ort

The www-data user needs to be able to run the ort command with sudo permissions without password and it needs to be able to kill it as well, under the ort user.

Edit the /etc/sudoers file or add an fossid-ort file with visudo:

sudo visudo -f /etc/sudoers.d/fossid-ort

Add the following lines at the end of the file:

www-data ALL=(ort) NOPASSWD:/fossid/lib/ort/bin/ort, /bin/kill, /usr/bin/kill
Defaults:www-data secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/bin

NOTE: ALLOWING THE WWW-DATA USER TO RUN ANY OTHER COMMANDS WITH SUDO IS A SECURITY RISK! MAKE SURE YOU GOT THE PATH RIGHT!

Save the changes and exit the editor.

Set the path to ORT in fossid.conf

Find and uncomment the following option in fossid.conf and set the path to ort correctly:

webapp_dependency_analysis_tool="sudo -u ort /fossid/lib/ort/bin/ort"

Update package manager list in fossid.conf

Find and uncomment the following option in fossid.conf and update the list.

webapp_dependency_analysis_supported_package_managers='Bundler,DotNet,Gradle,Maven,NPM,PIP,Yarn'

Log in to FossID and confirm you can see the “Dependencies” in the Scan View (on the right).

Supported package managers

If you have not installed them already, install the package managers you need to scan your projects. FossID/ORT supports the package managers listed below.

; List of package managers that ORT should use to resolve dependencies
; Supported package managers to be activated:
;     Bower, Bundler, Cargo, Carthage, CocoaPods, Composer, Conan, DotNet, GoDep, GoMod, Gradle, Maven, NPM,
;     NuGet, PIP, Pipenv, PNPM, Poetry, Pub, SBT, Stack, Yarn, Yarn2
; Modifying this list may cause unexpected behavior
;webapp_dependency_analysis_supported_package_managers='Bundler,DotNet,Gradle,Maven,NPM,PIP,Yarn'

You should follow the installation instructions for the individual package managers depending on your environment.

Enable ORT behind a proxy

If your FossID Workbench server runs behind a proxy, the user running the php service (typically the www-data user) needs to have the http_proxy and https_proxy environment variables defined. This needs to be in a number of places:

Add following lines in the www.conf of the php module:

env[http_proxy]=http://http_proxy_server:port
env[https_proxy]=http://https_proxy_server:port

In Debian, the www.conf is in /etc/php/<version>/fpm/pool.d/www.conf In RHEL, it is in /etc/php-fpm.d/www.conf

Restart fpm and NginX service after the change

In the sudoers file, add the SETENV part in the previously added exception for the www-data user (or any other user running the php service):

    www-data ALL=(ort) NOPASSWD:SETENV:/fossid/lib/ort/bin/ort, /bin/kill, /usr/bin/kill

In fossid.conf, the webapp_dependency_analysis_tool needs to be specified with the -E argument to sudo:

    ; Dependency analysis tool
    webapp_dependency_analysis_tool="sudo -E -u ort /fossid/lib/ort/bin/ort"

Copyright (C) 2017-2020 HERE Europe B.V.

OSS Review Toolkit (ORT) is a Linux Foundation project and part of ACT.

OSS Review Toolkit is licensed under Apache License 2.0.

Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

Terms and Conditions for use, reproduction, and distribution

1. Definitions

“License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

“Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

“Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

“You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.

“Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

“Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

“Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

“Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

“Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.”

“Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution

You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

  • (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
  • (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
  • (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
  • (d) If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions

Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks

This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability

While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets [] replaced with your own identifying information. (Don’t include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same “printed page” as the copyright notice for easier identification within third-party archives.

    Copyright [yyyy] [name of copyright owner]

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
FossID Workbench Help, version 2025.1.0