CycloneDX/sbom-utility

Add support for displaying/validating CDX Signature schema (struct)

Open

#27 opened on May 19, 2023

View on GitHubContributor guide
 (0 comments) (1 reaction) (0 assignees)Go (20 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (155 stars)
PR merge metrics
 (PR metrics pending)

Description

i.e., add property Signature CDXSignaturejson:"signature,omitempty"to top-levelCDXBom` structure. Then support it with signing verification (validation) with testcases.

This will be a bit of a challenge as we may also need to implement JSF schema:

As referenced by the CycloneDX schema (external).

As we want the utility to work in a network-disconnected environment (e.g., a secure build pipeline), this would have to bring in a static encoding (marshal/unmarshal, etc.)

Contributor guide

Research direction
Add the 'signature' field to the CDXBom struct, then implement signature verification using JSON Schema. For offline use, embed the JSF schema or implement static validation. Start by studying the CycloneDX signature specification and existing validation patterns in the project.
Tech stack
go
Domain
backendsecurity
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoJSONCycloneDX
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40