Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accept BOM uploads in Protobuf format #1071

Merged
merged 6 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.json.JsonMapper;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.ws.rs.core.MediaType;
import org.cyclonedx.Version;
import org.cyclonedx.exception.ParseException;
import org.cyclonedx.parsers.JsonParser;
import org.cyclonedx.parsers.Parser;
import org.cyclonedx.parsers.XmlParser;
import org.cyclonedx.proto.v1_6.Bom;

import javax.xml.XMLConstants;
import javax.xml.stream.XMLInputFactory;
Expand Down Expand Up @@ -72,24 +75,42 @@ public static CycloneDxValidator getInstance() {
}

public void validate(final byte[] bomBytes) {
final FormatAndVersion formatAndVersion = detectFormatAndSchemaVersion(bomBytes);

final Parser bomParser = switch (formatAndVersion.format()) {
case JSON -> new JsonParser();
case XML -> new XmlParser();
};

final List<ParseException> validationErrors;
try {
validationErrors = bomParser.validate(bomBytes, formatAndVersion.version());
} catch (IOException e) {
throw new RuntimeException("Failed to validate BOM", e);
}
validate(bomBytes, null);
}

if (!validationErrors.isEmpty()) {
throw new InvalidBomException("Schema validation failed", validationErrors.stream()
.map(ParseException::getMessage)
.toList());
public void validate(final byte[] bomBytes, MediaType mediaType) {
// Validating protobuf format
if (mediaType != null && mediaType.toString().equalsIgnoreCase("application/x.vnd.cyclonedx+protobuf")) {
try {
final var bom = Bom.parseFrom(bomBytes);
switch (bom.getSpecVersion()) {
case "1.0", "1.1", "1.2", "1.3", "1.4" ->
throw new InvalidBomException("Protobuf is not supported for specVersion %s".formatted(bom.getSpecVersion()));
case "1.5", "1.6" -> {}
default ->
throw new InvalidBomException("Unrecognized specVersion %s".formatted(bom.getSpecVersion()));
}
} catch (InvalidProtocolBufferException e) {
throw new InvalidBomException("Protobuf Schema validation failed", e);
}
} else {
// Validating JSON/XML format
final FormatAndVersion formatAndVersion = detectFormatAndSchemaVersion(bomBytes);
final Parser bomParser = switch (formatAndVersion.format()) {
case JSON -> new JsonParser();
case XML -> new XmlParser();
};
final List<ParseException> validationErrors;
try {
validationErrors = bomParser.validate(bomBytes, formatAndVersion.version());
} catch (IOException e) {
throw new RuntimeException("Failed to validate BOM", e);
}
if (!validationErrors.isEmpty()) {
throw new InvalidBomException("Schema validation failed", validationErrors.stream()
.map(ParseException::getMessage)
.toList());
}
}
}

Expand Down
Loading
Loading