public static string Serialize(Bom bom)
{
// hacky workaround for current not complete spec multi-version support
// the XML serializer defaults to version 1.1
var bomSpecVersion = bom.SpecVersion;
if (string.IsNullOrEmpty(bomSpecVersion))
{
bom.SpecVersion = "1.2";
}
Contract.Requires(bom != null);
var options = new JsonSerializerOptions
{
WriteIndented = true,
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
IgnoreNullValues = true,
};
options.Converters.Add(new LicenseConverter());
var jsonBom = JsonSerializer.Serialize(bom, options);
bom.SpecVersion = bomSpecVersion;
return(jsonBom);
}
public static string Serialize(Bom bom)
{
Contract.Requires(bom != null);
var options = new JsonSerializerOptions
{
WriteIndented = true,
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
IgnoreNullValues = true,
};
options.Converters.Add(new LicenseConverter());
var jsonBom = JsonSerializer.Serialize(bom, options);
return(jsonBom);
}
public static string Serialize(Bom bom)
{
Contract.Requires(bom != null);
XNamespace ns = "http://cyclonedx.org/schema/bom/1.1";
var doc = new XDocument();
doc.Declaration = new XDeclaration("1.0", "utf-8", null);
var bomElement = (string.IsNullOrEmpty(bom.SerialNumber)) ? new XElement(ns + "bom", new XAttribute("version", bom.Version)) :
new XElement(ns + "bom", new XAttribute("version", bom.Version), new XAttribute("serialNumber", bom.SerialNumber));
var sortedComponents = bom.Components.ToList();
sortedComponents.Sort();
var com = new XElement(ns + "components");
foreach (var component in sortedComponents)
{
var c = new XElement(ns + "component", new XAttribute("type", component.Type));
if (!string.IsNullOrEmpty(component.Group))
{
c.Add(new XElement(ns + "group", component.Group));
}
if (!string.IsNullOrEmpty(component.Name))
{
c.Add(new XElement(ns + "name", component.Name));
}
if (!string.IsNullOrEmpty(component.Version))
{
c.Add(new XElement(ns + "version", component.Version));
}
if (!string.IsNullOrEmpty(component.Description))
{
c.Add(new XElement(ns + "description", new XCData(component.Description)));
}
if (!string.IsNullOrEmpty(component.Scope))
{
c.Add(new XElement(ns + "scope", component.Scope));
}
if (component.Licenses != null && component.Licenses.Count > 0)
{
var l = new XElement(ns + "licenses");
foreach (var componentLicense in component.Licenses)
{
var license = componentLicense.License;
if (license.Id != null)
{
l.Add(new XElement(ns + "license", new XElement(ns + "id", license.Id)));
}
else if (license.Name != null)
{
l.Add(new XElement(ns + "license", new XElement(ns + "name", license.Name)));
}
else if (license.Url != null)
{
l.Add(new XElement(ns + "license", new XElement(ns + "url", license.Url)));
}
}
c.Add(l);
}
if (!string.IsNullOrEmpty(component.Copyright))
{
c.Add(new XElement(ns + "copyright", component.Copyright));
}
if (!string.IsNullOrEmpty(component.Purl))
{
c.Add(new XElement(ns + "purl", component.Purl));
}
if (component.ExternalReferences != null && component.ExternalReferences.Count > 0)
{
var externalReferences = new XElement(ns + "externalReferences");
foreach (var externalReference in component.ExternalReferences)
{
externalReferences.Add(new XElement(ns + "reference", new XAttribute("type", externalReference.Type), new XElement(ns + "url", externalReference.Url)));
}
c.Add(externalReferences);
}
com.Add(c);
}
bomElement.Add(com);
doc.Add(bomElement);
using (var sw = new Utf8StringWriter())
{
doc.Save(sw);
return(sw.ToString());
}
}
public static string Serialize(Bom bom)
{
Contract.Requires(bom != null);
// hacky work around for incomplete spec multi-version support, JSON defaults to v1.2
XNamespace ns = "http://cyclonedx.org/schema/bom/" + (string.IsNullOrEmpty(bom.SpecVersion) ? "1.1" : bom.SpecVersion);
var doc = new XDocument();
doc.Declaration = new XDeclaration("1.0", "utf-8", null);
var bomElement = (string.IsNullOrEmpty(bom.SerialNumber)) ? new XElement(ns + "bom", new XAttribute("version", bom.Version)) :
new XElement(ns + "bom", new XAttribute("version", bom.Version), new XAttribute("serialNumber", bom.SerialNumber));
if (bom.Metadata != null)
{
var meta = new XElement(ns + "metadata");
if (bom.Metadata.Authors != null && bom.Metadata.Authors.Count > 0)
{
var authors = new XElement(ns + "authors");
foreach (var author in bom.Metadata.Authors)
{
var a = new XElement(ns + "author");
if (!string.IsNullOrEmpty(author.Name))
{
a.Add(new XElement(ns + "name", author.Name));
}
if (!string.IsNullOrEmpty(author.Email))
{
a.Add(new XElement(ns + "email", author.Email));
}
if (!string.IsNullOrEmpty(author.Phone))
{
a.Add(new XElement(ns + "phone", author.Phone));
}
authors.Add(a);
}
meta.Add(authors);
}
bomElement.Add(meta);
}
var sortedComponents = bom.Components.ToList();
sortedComponents.Sort();
var com = new XElement(ns + "components");
foreach (var component in sortedComponents)
{
var c = new XElement(ns + "component", new XAttribute("type", component.Type));
if (!string.IsNullOrEmpty(component.Group))
{
c.Add(new XElement(ns + "group", component.Group));
}
if (!string.IsNullOrEmpty(component.Name))
{
c.Add(new XElement(ns + "name", component.Name));
}
if (!string.IsNullOrEmpty(component.Version))
{
c.Add(new XElement(ns + "version", component.Version));
}
if (!string.IsNullOrEmpty(component.Description))
{
c.Add(new XElement(ns + "description", new XCData(component.Description)));
}
if (!string.IsNullOrEmpty(component.Scope))
{
c.Add(new XElement(ns + "scope", component.Scope));
}
if (component.Licenses != null && component.Licenses.Count > 0)
{
var l = new XElement(ns + "licenses");
foreach (var componentLicense in component.Licenses)
{
var license = componentLicense.License;
if (license.Id != null)
{
l.Add(new XElement(ns + "license", new XElement(ns + "id", license.Id)));
}
else if (license.Name != null)
{
l.Add(new XElement(ns + "license", new XElement(ns + "name", license.Name)));
}
else if (license.Url != null)
{
l.Add(new XElement(ns + "license", new XElement(ns + "url", license.Url)));
}
}
c.Add(l);
}
if (!string.IsNullOrEmpty(component.Copyright))
{
c.Add(new XElement(ns + "copyright", component.Copyright));
}
if (!string.IsNullOrEmpty(component.Purl))
{
c.Add(new XElement(ns + "purl", component.Purl));
}
if (component.ExternalReferences != null && component.ExternalReferences.Count > 0)
{
var externalReferences = new XElement(ns + "externalReferences");
foreach (var externalReference in component.ExternalReferences)
{
externalReferences.Add(new XElement(ns + "reference", new XAttribute("type", externalReference.Type), new XElement(ns + "url", externalReference.Url)));
}
c.Add(externalReferences);
}
com.Add(c);
}
bomElement.Add(com);
doc.Add(bomElement);
using (var sw = new Utf8StringWriter())
{
doc.Save(sw);
return(sw.ToString());
}
}