Giter Club home page Giter Club logo

cyclonedx-linux-generator's Introduction

Build Status Maven Central License Website Slack Invite Group Discussion Twitter

cyclonedx-linux-generator

Lockheed Martin developed utility to generate CycloneDX SBOMs for Linux distributions

This project creates a utility that users can utilize in generating Software Bill of Materials (SBom) file for Unix Operating Systems. It currently will create an SBOM for Alpine, Debian, Centos, Redhat and Ubuntu.

This utility can also work well with docker containers who runs Alpine(*), Debian, Centos, Redhat or Ubuntu.

Note: For Alpine you must have bash and java installed to run.

Prerequisites

  • Open JDK11
  • Apache Maven 3.6.3 or greater installed
  • (Recommended) java IDE Eclipse with Subclipse 4.3.0 plug-in
  • Unix Based Operating System.

Usage:

To Build this project into an artifact via maven.

Maven Command

    mvn clean package

To Run

To run as a standalone java application, you can look at the "start.sh" shell script for an example. You can also use the provided "start.sh" script as a pass through to the jar. It assumes all the basic settings.

Help is available.

    ./start.sh -h

Help Output shows options for running the SBomCombiner application.

usage: help
    -g, --group <arg>     (Optional) Group value to assign to top level component.
    -h, --help            will print out the command line options.
    -i, --image <arg>     (Optional) Docker Image file to use as top level component.
    -n, --name <arg>      (Optional) Name value to assign to top level component.
    -nc, --no-components  (Optional) Will only campture master component.  Will not include any components in the list of Components.
     -v, --version <arg>  (Optional) Version value to assign to top level component.

Logging

Logs

"start.sh" script will create a directory for the logs (logs).

Output

bom.xml

"start.sh" will create a directory (output) for the bom.xml file.  

Copyright & License

CycloneDX Linux Generator is Copyright (c) Lockheed Martin Corporation. All Rights Reserved.

Permission to modify and redistribute is granted under the terms of the Apache 2.0 license. See the License file for the full license.

cyclonedx-linux-generator's People

Contributors

stevespringett avatar dependabot[bot] avatar wrgoff avatar jurrie 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.