Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 4.07 KB

README.md

File metadata and controls

81 lines (59 loc) · 4.07 KB
Raw

Coverage Status

Cavil

Cavil is a legal review and Software Bill of Materials (SBOM) system for the Open Build Service. It is used in the development of openSUSE Tumbleweed, openSUSE Leap, as well as SUSE Linux Enterprise.

Features

  • Source code legal review system for RPMs, Tarballs, Kiwi images, Docker images, and Helm charts
  • High performance source code scanner with support for recursively decompressing almost any archive format
  • 28.000 curated patterns for 2000 license combinations with 500 distinct SPDX expressions
  • Software Bill of Materials (SBOM) support with SPDX 2.2 reports
  • Legal risk assessments by lawyers for every pattern match
  • Human reviews with approval/rejection workflow, and optional automatic approvals based on risk
  • Optional support for machine learning models to classify pattern matches
  • REST API for integration into existing source code management systems
  • Open Build Service integration via bots
  • OpenID Connect (OAuth 2.0) authentication

Important: Note that most of the data used by Cavil has been curated by lawyers, but the generated reports do not count as legal advice and no guarantees are made for their correctness!

Screenshot

Components

This distribution contains the two main components of the system. A Mojolicious web application that lawyers can use to efficiently review package contents, and Minion background jobs to process and index packages, to create easy to digest license reports.

Additionally there is large curated set of license patterns the SUSE lawyers have created included in this distribution. Currently this set consists of over 20000 patterns for all known Open Source licenses.

The easiest way to connect OBS to Cavil is the legal-auto.py bot from the openSUSE Release Tools repository. But you can also upload tarballs directly for analysis.

AI

It is strongly recommended to combine Cavil with a machine learning model for text classification. Because the pattern matching system used for identifying clusters of legal keywords (snippets) has a false-positive rate of about 80%. Even a simple model can identify almost all of them.

There are currently two example implementations for a companion server application (usually running on port 5000):

  1. https://github.com/kraih/Character-level-cnn-pytorch/
  2. https://github.com/kraih/llama-lawyer

Getting Started

The easiest way to get started with Cavil is the included staging scripts for setting up a quick development environment. All you need is an empty PostgreSQL database (with the pgcrypto extension activated) and the following dependencies:

$ sudo zypper in -C postgresql-server postgresql-contrib 'rubygem(sass)'
$ sudo zypper in -C perl-Mojolicious perl-Mojolicious-Plugin-Webpack \
  perl-Mojo-Pg perl-Minion perl-File-Unpack perl-Cpanel-JSON-XS \
  perl-Spooky-Patterns-XS perl-Mojolicious-Plugin-OAuth2 perl-Mojo-JWT \
  perl-BSD-Resource perl-Term-ProgressBar perl-Text-Glob
$ npm i
$ npm run build

Then use these commands to set up and tear down a development environment:

$ perl staging/start.pl postgresql://tester:testing@/test
...
$ CAVIL_CONF=staging/do_not_commit/cavil.conf morbo script/cavil
...
$ CAVIL_CONF=staging/do_not_commit/cavil.conf script/cavil minion worker
...
$ perl staging/stop.pl
...

The morbo development web server will make the web application available under http://127.0.0.1:3000. And script/cavil minion worker will start the job queue for processing background jobs.

Documentation

For more information see the included documentation.