Skip to content

Commit

Permalink
Use CycloneDX 1.5 specification
Browse files Browse the repository at this point in the history 
Signed-off-by: Stewart X Addison <[email protected]>
  • Loading branch information
@sxa
sxa committed Dec 4, 2023
1 parent d2d70db commit e052a07
Showing 1 changed file with 49 additions and 16 deletions.
65 changes: 49 additions & 16 deletions cyclonedx-lib/src/temurin/sbom/TemurinGenSBOM.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import java.io.FileWriter;
import java.util.Collections;
import java.util.List;
import java.util.LinkedList;

/**
* Command line tool to construct a CycloneDX SBOM.
Expand Down Expand Up @@ -60,7 +61,7 @@ public static void main(final String[] args) {
String url = null;
String value = null;
String version = null;

for (int i = 0; i < args.length; i++) {
if (args[i].equals("--jsonFile")) {
fileName = args[++i];
Expand Down Expand Up @@ -104,10 +105,11 @@ public static void main(final String[] args) {
cmd = "addMetadataTools";
} else if (args[i].equals("--addFormulation")) { // Formulation Component. We can set "name" for Formulation.
cmd = "addFormulation";
System.out.println("SXAEC: Found addFormulation command");
} else if (args[i].equals("--addFormulationComp")) { // Formulation Component. We can set "name" for Formulation.
cmd = "addFormulation";
cmd = "addFormulationComp";
} else if (args[i].equals("--addFormulationCompProp")) { // Formulation --> Component --> Property --> name-value
cmd = "addFormulationProperty";
cmd = "addFormulationCompProp";
} else if (args[i].equals("--verbose")) {
verbose = true;
}
Expand All @@ -134,13 +136,15 @@ public static void main(final String[] args) {
break;

case "addFormulation": // Adds Formulation --> name
System.out.println("SXAEC: Calling addFormulation");
bom = addFormula(fileName);
writeJSONfile(bom, fileName);
break;

case "addFormulationComp": // Adds Formulation --> Component--> name
bom = addFormulaComponent(fileName, name, type);
writeJSONfile(bom, fileName);
System.out.println("SXAEC: Writing JSON file");
break;
case "addFormulationCompProp": // Adds Formulation--> Property --> name-value:
bom = addFormulaComponentProperty(fileName, compName, name, value);
Expand Down Expand Up @@ -291,42 +295,71 @@ static Bom addComponentExternalReference(final String fileName, final String has
}

static Bom addFormula(final String fileName) { // Method to store Formulation
System.out.println("SXAEC: addFormula");
Bom bom = readJSONfile(fileName);
if ( bom == null ) System.out.println("SXAEC: bom object is null");
List<Formula> formulation = bom.getFormulation();
Formula formula = new Formula();
// Assume this is auto-created List<Formula> formulation = new LinkedList<Formula>();
formulation.add(formula);
bom.setFormulation(formulation);
if ( formulation == null ) {
System.out.println("formulation in bom is null, creating one");
formulation = new LinkedList<Formula>();
Formula formula = new Formula();
formulation.add(formula);
bom.setFormulation(formulation);
if ( bom.getFormulation() == null ) System.out.println("Formulation is apparently still null :eyeroll:");
} else {
System.out.println("addFormula() has done nothing as there is a already a formulation object in the BoM");
}
return bom;
}

static Bom addFormulaComponent(final String fileName, final String name, final String type/*, final String version, final String description */) {
// START OF SECTION FROM addFormula
System.out.println("SXAEC: addFormula");
Bom bom = readJSONfile(fileName);
if ( bom == null ) System.out.println("SXAEC: bom object is null");
List<Formula> formulation = bom.getFormulation();
if ( formulation == null ) {
formulation = new LinkedList<Formula>();
Formula formula = new Formula();
formulation.add(formula);
bom.setFormulation(formulation);
} else {
System.out.println("addFormula() has done nothing as there is a already a formulation object in the BoM");
}
// END OF SECTION FROM addFormula
// Bom bom = readJSONfile(fileName);
// List<Formula> formulation = bom.getFormulation();
// SXA TODO: Not ideal to just be pulling the first entry here
// But the formula is currently unnamed
if ( formulation==null ) System.out.println("formulation in the bom is null");
Formula formula = formulation.get(0);
if ( formula==null ) System.out.println("formula in the bom is null");
Component comp = new Component();
Component.Type compType = Component.Type.FRAMEWORK;
/* comp.setType(compType); // required e.g Component.Type.FRAMEWORK
comp.setName(name); // required */
comp.setType(compType);
comp.setName(name);
List<Component> components = formula.getComponents();
if ( components == null ) {
System.out.println("SXAEC: INITIAL FORMULATION COMPONENTS IS NULL");
// components = new LinkedList<Component>();
}
else if ( components.isEmpty() ) {
components = new LinkedList<Component>();
} else if ( components.isEmpty() ) {
System.out.println("SXAEC: INITIAL FORMULATION COMPONENTS IS PRESENT BUT EMPTY");
}
components.add(comp);
formula.setComponents(components);
bom.setFormulation(formulation);
formulation.set(0,formula);
bom.setFormulation(formulation); // Not really required
if ( bom.getFormulation().get(0).getComponents().get(0) == null ) System.out.println("Object retrieval was null");
else System.out.println("Retrieved name: " + bom.getFormulation().get(0).getComponents().get(0).getName());
System.out.println("SXAEC: Everything set");
return bom;
}

static Bom addFormulaComponentProperty(final String fileName, final String componentName, final String name, final String value) { // Method to store metadata --> Properties List --> name-values
Bom bom = readJSONfile(fileName);
List<Formula> formulation = bom.getFormulation();
Formula formula = formulation.get(0);
// This isn't great as we're assuming there's only one
// Similar to the last method this isn't great as we're assuming there's only one
// But we can't create more, and they're not named ...
List<Component> components = formulation.get(0).getComponents();
for (Component item : components) {
Expand All @@ -346,8 +379,8 @@ static Bom addFormulaComponentProperty(final String fileName, final String compo
return bom;
}
static String generateBomJson(final Bom bom) {
// Use schema v14: https://cyclonedx.org/schema/bom-1.4.schema.json
BomJsonGenerator bomGen = BomGeneratorFactory.createJson(CycloneDxSchema.Version.VERSION_14, bom);
// Use schema v15: https://cyclonedx.org/schema/bom-1.5.schema.json
BomJsonGenerator bomGen = BomGeneratorFactory.createJson(CycloneDxSchema.Version.VERSION_15, bom);
String json = bomGen.toJsonString();
return json;
}
Expand Down

0 comments on commit e052a07

Please sign in to comment.