Code Monkey home page Code Monkey logo

sheriff123 / quickscan Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jalenchen0214/quickscan

0.0 0.0 0.0 1.01 MB

SCANOSS Quickscan is a tool that demonstrates scanning source code against osskb.org. SCANOSS Quickscan scans source code against a knowledge base representing the entire OSS community. The results of the scan contain OSS matches (full file or snippet) of the scanned code against OSS components.

License: GNU General Public License v2.0

CSS 2.03% HTML 23.69% JavaScript 73.22% Shell 1.06%

quickscan's Introduction

SCANOSS Quickscan Lite Logo

What is SCANOSS Quickscan Lite?

It is a tool that demonstrates scanning source code against osskb.org. SCANOSS Quickscan scans source code against a knowledge base representing the entire OSS community. The results of the scan contain OSS matches (full file or snippet) of the scanned code against OSS components.

Screenshot

How does it work?

Select a folder containing source code files and the application will generate fingerprints and send them to the OSSKB API for scanning. It is important to stress that no source code is sent to the osskb.org API. The client extracts hashes from the source code using an open source algorithm. A good explanation of the algorithm as well as an implementation can be found here: https://github.com/scanoss/wfp.

Quickscan will show a simple visualisation that represents the data contained in the scan results. If you click on a segment in the licenses chart, you will be presented with a table containing the list of components where a particular license has been detected. Similarly, if you click on a severity in the vulnerability chart, you will see the components affected by vulnerabilites with the selected severity.

You can also download the full report of the scan in CSV format, via the "DOWNLOAD REPORT" button on the top right corner.

About the results

The results of the scan support building a Software Bill of Materials (SBOM) of a software product. The SBOM describes the list of software components in a product. They can also provide additional information that can help evaluate the use of the component.

The CSV Report provided by SCANOSS Quickscan should be considered as a draft SBOM.

Each OSS component match provided by osskb.org contains the following metadata:

  • Component identification (vendor, component, version, url...)
  • License identifications
  • Copyright notices
  • Vulnerabilities

Next Steps

For an enhanced scanning experience with richer results, visit https://scanoss.com

quickscan's People

Contributors

isasmendiagus avatar mscasso-scanoss avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.