CycloneDX v1.1 XML Reference
Schema Document Properties
Target Namespace | http://cyclonedx.org/schema/bom/1.1 |
---|---|
Version | 1.1 |
Element and Attribute Namespaces |
|
Schema Composition |
|
Global Declarations
Element: bom
<bom:bom version="xs:integer" [0..1] serialNumber="bom:urnUuid" [0..1] Allow any attributes from any namespace (lax validation). > <!-- Uniqueness Constraint - bom-ref Selector - .//* Field(s) - @bom-ref --> <bom:components> bom:componentsType </bom:components> [1] <bom:externalReferences> bom:externalReferences </bom:externalReferences> [0..1] Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] </bom:bom>
<xs:element name="bom"> <xs:complexType> <xs:sequence> <xs:element name="components" type="bom:componentsType"/> <xs:element name="externalReferences" type="bom:externalReferences" minOccurs="0" maxOccurs="1"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="version" type="xs:integer" default="1"/> <xs:attribute name="serialNumber" type="bom:urnUuid"/> <xs:anyAttribute namespace="##any" processContents="lax"/> </xs:complexType> <xs:unique name="bom-ref"> <xs:selector xpath=".//*"/> <xs:field xpath="@bom-ref"/> </xs:unique> </xs:element>
Global Definitions
Complex Type: commitType
Super-types: | None |
---|---|
Sub-types: | None |
Name | commitType |
---|---|
Abstract | no |
<...> <bom:uid> xs:normalizedString </bom:uid> [0..1] <bom:url> xs:anyURI </bom:url> [0..1] <bom:author> bom:identifiableActionType </bom:author> [0..1] <bom:committer> bom:identifiableActionType </bom:committer> [0..1] <bom:message> xs:normalizedString </bom:message> [0..1] Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] </...>
<xs:complexType name="commitType"> <xs:sequence> <xs:element name="uid" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:element name="url" type="xs:anyURI" minOccurs="0" maxOccurs="1"/> <xs:element name="author" type="bom:identifiableActionType" minOccurs="0" maxOccurs="1"/> <xs:element name="committer" type="bom:identifiableActionType" minOccurs="0" maxOccurs="1"/> <xs:element name="message" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
Complex Type: commitsType
Super-types: | None |
---|---|
Sub-types: | None |
Name | commitsType |
---|---|
Abstract | no |
<...> Start Sequence [0..*] <bom:commit> bom:commitType </bom:commit> [1] Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] End Sequence </...>
Complex Type: component
Super-types: | None |
---|---|
Sub-types: | None |
Name | component |
---|---|
Abstract | no |
<... type="bom:classification" [1] bom-ref="bom:refType" [0..1] Allow any attributes from any namespace (lax validation). > <bom:publisher> xs:normalizedString </bom:publisher> [0..1] <bom:group> xs:normalizedString </bom:group> [0..1] <bom:name> xs:normalizedString </bom:name> [1] <bom:version> xs:normalizedString </bom:version> [1] <bom:description> xs:normalizedString </bom:description> [0..1] <bom:scope> bom:scope </bom:scope> [0..1] <bom:hashes > [0..1] Start Sequence [0..*] <bom:hash> bom:hashType </bom:hash> [1] End Sequence </bom:hashes> <bom:licenses > [0..1] Start Choice [1] <bom:license> bom:licenseType </bom:license> [0..*] <bom:expression> xs:normalizedString </bom:expression> [0..1] End Choice </bom:licenses> <bom:copyright> xs:normalizedString </bom:copyright> [0..1] <bom:cpe> bom:cpe </bom:cpe> [0..1] <bom:purl> xs:anyURI </bom:purl> [0..1] <bom:modified> xs:boolean </bom:modified> [0..1] <bom:pedigree> bom:pedigreeType </bom:pedigree> [0..1] <bom:externalReferences> bom:externalReferences </bom:externalReferences> [0..1] <bom:components > [0..1] Start Sequence [0..*] <bom:component> bom:component </bom:component> [1] Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] End Sequence </bom:components> Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] </...>
<xs:complexType name="component"> <xs:sequence> <xs:element name="publisher" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:element name="group" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:element name="name" type="xs:normalizedString" minOccurs="1" maxOccurs="1"/> <xs:element name="version" type="xs:normalizedString" minOccurs="1" maxOccurs="1"/> <xs:element name="description" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:element name="scope" type="bom:scope" minOccurs="0" maxOccurs="1"/> <xs:element name="hashes" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence minOccurs="0" maxOccurs="unbounded"> <xs:element name="hash" type="bom:hashType"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="licenses" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:choice> <xs:element name="license" type="bom:licenseType" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="expression" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> </xs:choice> </xs:complexType> </xs:element> <xs:element name="copyright" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:element name="cpe" type="bom:cpe" minOccurs="0" maxOccurs="1"/> <xs:element name="purl" type="xs:anyURI" minOccurs="0" maxOccurs="1"/> <xs:element name="modified" type="xs:boolean" minOccurs="0" maxOccurs="1"/> <xs:element name="pedigree" type="bom:pedigreeType" minOccurs="0" maxOccurs="1"/> <xs:element name="externalReferences" type="bom:externalReferences" minOccurs="0" maxOccurs="1"/> <xs:element name="components" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence minOccurs="0" maxOccurs="unbounded"> <xs:element name="component" type="bom:component"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="type" type="bom:classification" use="required"/> <xs:attribute name="bom-ref" type="bom:refType"/> <xs:anyAttribute namespace="##any" processContents="lax"/> </xs:complexType>
Complex Type: componentsType
Super-types: | None |
---|---|
Sub-types: | None |
Name | componentsType |
---|---|
Abstract | no |
<xs:complexType name="componentsType"> <xs:sequence minOccurs="0" maxOccurs="unbounded"> <xs:element name="component" type="bom:component"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:anyAttribute namespace="##any" processContents="lax"/> </xs:complexType>
Complex Type: externalReference
Super-types: | None |
---|---|
Sub-types: | None |
Name | externalReference |
---|---|
Abstract | no |
<xs:complexType name="externalReference"> <xs:sequence> <xs:element name="url" type="xs:anyURI" minOccurs="1" maxOccurs="1"/> <xs:element name="comment" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute name="type" type="bom:externalReferenceType" use="required"/> <xs:anyAttribute namespace="##any" processContents="lax"/> </xs:complexType>
Complex Type: externalReferences
Super-types: | None |
---|---|
Sub-types: | None |
Name | externalReferences |
---|---|
Abstract | no |
<...> Start Sequence [0..*] <bom:reference> bom:externalReference </bom:reference> [1] End Sequence </...>
Complex Type: hashType
Name | hashType |
---|---|
Abstract | no |
Complex Type: identifiableActionType
Super-types: | None |
---|---|
Sub-types: | None |
Name | identifiableActionType |
---|---|
Abstract | no |
<xs:complexType name="identifiableActionType"> <xs:sequence> <xs:element name="timestamp" type="xs:dateTime" minOccurs="0" maxOccurs="1"/> <xs:element name="name" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:element name="email" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
Complex Type: licenseTextType
Super-types: | xs:string < licenseTextType (by extension) |
---|---|
Sub-types: | None |
Name | licenseTextType |
---|---|
Abstract | no |
Complex Type: licenseType
Super-types: | None |
---|---|
Sub-types: | None |
Name | licenseType |
---|---|
Abstract | no |
<...> Start Choice [1] <bom:id> spdx:licenseId </bom:id> [0..1] <bom:name> xs:normalizedString </bom:name> [0..1] End Choice <bom:text> bom:licenseTextType </bom:text> [0..1] <bom:url> xs:anyURI </bom:url> [0..1] Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] </...>
<xs:complexType name="licenseType"> <xs:sequence> <xs:choice> <xs:element name="id" type="spdx:licenseId" minOccurs="0" maxOccurs="1"/> <xs:element name="name" type="xs:normalizedString" minOccurs="0" maxOccurs="1"/> </xs:choice> <xs:element name="text" type="bom:licenseTextType" minOccurs="0" maxOccurs="1"/> <xs:element name="url" type="xs:anyURI" minOccurs="0" maxOccurs="1"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
Complex Type: pedigreeType
Super-types: | None |
---|---|
Sub-types: | None |
Name | pedigreeType |
---|---|
Abstract | no |
<...> <bom:ancestors> bom:componentsType </bom:ancestors> [0..1] <bom:descendants> bom:componentsType </bom:descendants> [0..1] <bom:variants> bom:componentsType </bom:variants> [0..1] <bom:commits> bom:commitsType </bom:commits> [0..1] <bom:notes> xs:string </bom:notes> [0..1] Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*] </...>
<xs:complexType name="pedigreeType"> <xs:sequence> <xs:element name="ancestors" type="bom:componentsType" minOccurs="0" maxOccurs="1"/> <xs:element name="descendants" type="bom:componentsType" minOccurs="0" maxOccurs="1"/> <xs:element name="variants" type="bom:componentsType" minOccurs="0" maxOccurs="1"/> <xs:element name="commits" type="bom:commitsType" minOccurs="0" maxOccurs="1"/> <xs:element name="notes" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
Simple Type: classification
Super-types: | xs:string < classification (by restriction) |
---|---|
Sub-types: | None |
Name | classification |
---|---|
Content |
|
<xs:simpleType name="classification"> <xs:restriction base="xs:string"> <xs:enumeration value="application"/> <xs:enumeration value="framework"/> <xs:enumeration value="library"/> <xs:enumeration value="operating-system"/> <xs:enumeration value="device"/> <xs:enumeration value="file"/> </xs:restriction> </xs:simpleType>
Simple Type: cpe
Super-types: | xs:string < cpe (by restriction) |
---|---|
Sub-types: | None |
Name | cpe |
---|---|
Content |
|
<xs:simpleType name="cpe"> <xs:restriction base="xs:string"> <xs:pattern value="([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9\._\-~%]*){0,6})|(cpe:2\.3:[aho\*\-](:(((\?*|\*?)([a-zA-Z0-9\-\._]|(\\[\\\*\?!"#$$%&'\(\)\+,/:;<=>@\[\]\^`\{\|}~]))+(\?*|\*?))|[\*\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[\*\-]))(:(((\?*|\*?)([a-zA-Z0-9\-\._]|(\\[\\\*\?!"#$$%&'\(\)\+,/:;<=>@\[\]\^`\{\|}~]))+(\?*|\*?))|[\*\-])){4})"/> </xs:restriction> </xs:simpleType>
Simple Type: encoding
Super-types: | xs:string < encoding (by restriction) |
---|---|
Sub-types: | None |
Name | encoding |
---|---|
Content |
|
Simple Type: externalReferenceType
Super-types: | xs:string < externalReferenceType (by restriction) |
---|---|
Sub-types: | None |
Name | externalReferenceType |
---|---|
Content |
|
<xs:simpleType name="externalReferenceType"> <xs:restriction base="xs:string"> <xs:enumeration value="vcs"/> <xs:enumeration value="issue-tracker"/> <xs:enumeration value="website"/> <xs:enumeration value="advisories"/> <xs:enumeration value="bom"/> <xs:enumeration value="mailing-list"/> <xs:enumeration value="social"/> <xs:enumeration value="chat"/> <xs:enumeration value="documentation"/> <xs:enumeration value="support"/> <xs:enumeration value="distribution"/> <xs:enumeration value="license"/> <xs:enumeration value="build-meta"/> <xs:enumeration value="build-system"/> <xs:enumeration value="other"/> </xs:restriction> </xs:simpleType>
Simple Type: hashAlg
Super-types: | xs:string < hashAlg (by restriction) |
---|---|
Sub-types: | None |
Name | hashAlg |
---|---|
Content |
|
<xs:simpleType name="hashAlg"> <xs:restriction base="xs:string"> <xs:enumeration value="MD5"/> <xs:enumeration value="SHA-1"/> <xs:enumeration value="SHA-256"/> <xs:enumeration value="SHA-384"/> <xs:enumeration value="SHA-512"/> <xs:enumeration value="SHA3-256"/> <xs:enumeration value="SHA3-512"/> </xs:restriction> </xs:simpleType>
Simple Type: hashValue
Name | hashValue |
---|---|
Content |
|
Simple Type: refType
Super-types: | xs:string < refType (by restriction) |
---|---|
Sub-types: | None |
Name | refType |
---|---|
Content |
|
Simple Type: scope
Super-types: | xs:string < scope (by restriction) |
---|---|
Sub-types: | None |
Name | scope |
---|---|
Content |
|
Simple Type: urnUuid
Super-types: | xs:string < urnUuid (by restriction) |
---|---|
Sub-types: | None |
Name | urnUuid |
---|---|
Content |
|
Glossary
Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.
Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.
Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element
instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will
not validate element instances that have types derived from the element declaration's
type using the specified derivation methods. Normally, element instances can override
their declaration's type by specifying an xsi:type
attribute.
Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.
Nillable (Applies to element declarations). If an element declaration is nillable, instances
can use the xsi:nil
attribute. The xsi:nil
attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil
attribute set to true, it can be left empty, even though its element declaration
may have required content.
Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.
Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.
Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.
Element comment