First cut for automatic annotations and tagging

Signed-off-by: Prabhu Subramanian <prabhu@appthreat.com>
CycloneDX · Nov 11, 2024 · f48a806 · f48a806
1 parent 16a4907
commit f48a806
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/lib/stages/postgen/postgen.js b/lib/stages/postgen/postgen.js
@@ -287,18 +287,24 @@ export function cleanupEnv(_options) {
  * Annotate the document with annotator
  *
  * @param {Object} bomJson BOM JSON Object
- * @param {Object} _options CLI options
+ * @param {Object} options CLI options
  *
  * @returns {Object} Annotated BOM JSON
  */
-export function annotate(bomJson, _options) {
+export function annotate(bomJson, options) {
   if (!bomJson?.components) {
     return bomJson;
   }
   const bomAnnotations = bomJson.annotations || [];
   const cdxgenAnnotator = bomJson.metadata.tools.components.filter(
     (c) => c.name === "cdxgen",
   );
+  if (!cdxgenAnnotator.length) {
+    return bomJson;
+  }
+  const requiresContextTrimming = ["machine-learning", "ml"].includes(
+    options?.profile,
+  );
   const metadataAnnotations = textualMetadata(bomJson);
   if (metadataAnnotations && bomJson.metadata?.component?.["bom-ref"]) {
     bomAnnotations.push({
@@ -318,6 +324,9 @@ export function annotate(bomJson, _options) {
     if (tags?.length) {
       comp.tags = tags;
     }
+    if (requiresContextTrimming) {
+      comp.properties = undefined;
+    }
   }
   return bomJson;
 }
diff --git a/types/lib/stages/postgen/postgen.d.ts b/types/lib/stages/postgen/postgen.d.ts
@@ -42,9 +42,9 @@ export function cleanupEnv(_options: any): void;
  * Annotate the document with annotator
  *
  * @param {Object} bomJson BOM JSON Object
- * @param {Object} _options CLI options
+ * @param {Object} options CLI options
  *
  * @returns {Object} Annotated BOM JSON
  */
-export function annotate(bomJson: any, _options: any): any;
+export function annotate(bomJson: any, options: any): any;
 //# sourceMappingURL=postgen.d.ts.map
diff --git a/types/lib/stages/postgen/postgen.d.ts.map b/types/lib/stages/postgen/postgen.d.ts.map