https://github.com/cyclonedx/cyclonedx-linux-generator

Lockheed Martin developed utility to generate CycloneDX SBOMs for Linux distributions
https://github.com/cyclonedx/cyclonedx-linux-generator

bill-of-materials bom cyclonedx linux owasp sbom sbom-generator software-bill-of-materials

Last synced: 2 months ago
JSON representation

Lockheed Martin developed utility to generate CycloneDX SBOMs for Linux distributions

• Host: GitHub
• URL: https://github.com/cyclonedx/cyclonedx-linux-generator
• Owner: CycloneDX
• License: other
• Created: 2021-05-20T15:48:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-04T10:47:51.000Z (about 1 year ago)
• Last Synced: 2025-03-28T19:37:53.520Z (3 months ago)
• Topics: bill-of-materials, bom, cyclonedx, linux, owasp, sbom, sbom-generator, software-bill-of-materials
• Language: Java
• Homepage: https://cyclonedx.org/
• Size: 4.32 MB
• Stars: 46
• Watchers: 7
• Forks: 15
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/CycloneDX/cyclonedx-linux-generator/workflows/Maven%20CI/badge.svg)](https://github.com/CycloneDX/cyclonedx-linux-generator/actions?workflow=Maven+CI)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.cyclonedx.contrib.com.lmco.efoss.unix.sbom/cyclonedx-linux-generator/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.cyclonedx.contrib.com.lmco.efoss.unix.sbom/cyclonedx-linux-generator)

[![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)][License]

[![Website](https://img.shields.io/badge/https://-cyclonedx.org-blue.svg)](https://cyclonedx.org/)

[![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack&labelColor=393939)](https://cyclonedx.org/slack/invite)

[![Group Discussion](https://img.shields.io/badge/discussion-groups.io-blue.svg)](https://groups.io/g/CycloneDX)

[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow)](https://twitter.com/CycloneDX_Spec)

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

[License]: https://github.com/CycloneDX/cyclonedx-linux-generator/blob/master/LICENSE