package cyclonedx.v1_3

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Composition

• AGGREGATE_NOT_SPECIFIED = 0

  Default, no statement about the aggregate completeness is being made

• AGGREGATE_COMPLETE = 1

  The aggregate composition is complete

• AGGREGATE_INCOMPLETE = 2

  The aggregate composition is incomplete

• AGGREGATE_INCOMPLETE_FIRST_PARTY_ONLY = 3

  The aggregate composition is incomplete for first party components, complete for third party components

• AGGREGATE_INCOMPLETE_THIRD_PARTY_ONLY = 4

  The aggregate composition is incomplete for third party components, complete for first party components

• AGGREGATE_UNKNOWN = 5

  The aggregate composition completeness is unknown

Specifies attributes of the text

Used in: Diff, License, Swid

• optional string content_type = 1

  Specifies the content type of the text. Defaults to text/plain if not specified.

• optional string encoding = 2

  Specifies the optional encoding the text is represented in

• string value = 3

  SimpleContent value of element

• string spec_version = 1

  The version of the CycloneDX specification a BOM is written to (starting at version 1.3)

• optional int32 version = 2

  The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.

• optional string serial_number = 3

  Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.

• optional Metadata metadata = 4

  Provides additional information about a BOM.

• repeated Component components = 5

  Provides the ability to document a list of components.

• repeated Service services = 6

  Provides the ability to document a list of external services.

• repeated ExternalReference external_references = 7

  Provides the ability to document external references related to the BOM or to the project the BOM describes.

• repeated Dependency dependencies = 8

  Provides the ability to document dependency relationships.

• repeated Composition compositions = 9

  Provides the ability to document aggregate completeness

Used in: Component

• CLASSIFICATION_NULL = 0

• CLASSIFICATION_APPLICATION = 1

  A software application. Refer to https://en.wikipedia.org/wiki/Application_software for information about applications.

• CLASSIFICATION_FRAMEWORK = 2

  A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework for information on how frameworks vary slightly from libraries.

• CLASSIFICATION_LIBRARY = 3

  A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended.

• CLASSIFICATION_OPERATING_SYSTEM = 4

  A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to https://en.wikipedia.org/wiki/Operating_system

• CLASSIFICATION_DEVICE = 5

  A hardware device such as a processor, or chip-set. A hardware device containing firmware should include a component for the physical hardware itself, and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of known device properties: https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md

• CLASSIFICATION_FILE = 6

  A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file for information about files.

• CLASSIFICATION_CONTAINER = 7

  A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization

• CLASSIFICATION_FIRMWARE = 8

  A special type of software that provides low-level control over a devices hardware. Refer to https://en.wikipedia.org/wiki/Firmware

Used in: Pedigree

• optional string uid = 1

  A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.

• optional string url = 2

  The URL to the commit. This URL will typically point to a commit in a version control system.

• optional IdentifiableAction author = 3

  The author who created the changes in the commit

• optional IdentifiableAction committer = 4

  The person who committed or pushed the commit

• optional string message = 5

  The text description of the contents of the commit

Used in: Bom, Metadata, Pedigree

• Classification type = 1

  Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.

• optional string mime_type = 2

  The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.

• optional string bom_ref = 3

  An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

• optional OrganizationalEntity supplier = 4

  The organization that supplied the component. The supplier may often be the manufacture, but may also be a distributor or repackager.

• optional string author = 5

  The person(s) or organization(s) that authored the component

• optional string publisher = 6

  The person(s) or organization(s) that published the component

• optional string group = 7

  The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.

• string name = 8

  The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery

• string version = 9

  The component version. The version should ideally comply with semantic versioning but is not enforced.

• optional string description = 10

  Specifies a description for the component

• optional Scope scope = 11

  Specifies the scope of the component. If scope is not specified, 'runtime' scope should be assumed by the consumer of the BOM

• repeated Hash hashes = 12

• repeated LicenseChoice licenses = 13

• optional string copyright = 14

  An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.

• optional string cpe = 15

  DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe

• optional string purl = 16

  Specifies the package-url (PURL). The purl, if specified, must be valid and conform to the specification defined at: https://github.com/package-url/purl-spec

• optional Swid swid = 17

  Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.

• optional bool modified = 18

  DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original.

• optional Pedigree pedigree = 19

  Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc.

• repeated ExternalReference external_references = 20

  Provides the ability to document external references related to the component or to the project the component describes.

• repeated Component components = 21

  Specifies optional sub-components. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.

• repeated Property properties = 22

  Specifies optional, custom, properties

• repeated Evidence evidence = 23

  Specifies optional license and copyright evidence

Used in: Bom

• Aggregate aggregate = 1

  Indicates the aggregate completeness

• repeated string assemblies = 2

  The assemblies the aggregate completeness applies to

• repeated string dependencies = 3

  The dependencies the aggregate completeness applies to

Specifies the data classification.

Used in: Service

• DataFlow flow = 1

  Specifies the flow direction of the data.

• string value = 2

  SimpleContent value of element

Specifies the flow direction of the data. Valid values are: inbound, outbound, bi-directional, and unknown. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known.

Used in: DataClassification

• DATA_FLOW_NULL = 0

• DATA_FLOW_INBOUND = 1

• DATA_FLOW_OUTBOUND = 2

• DATA_FLOW_BI_DIRECTIONAL = 3

• DATA_FLOW_UNKNOWN = 4

Used in: Bom

• string ref = 1

  References a component or service by the its bom-ref attribute

• repeated Dependency dependencies = 2

Used in: Patch

• optional AttachedText text = 1

  Specifies the optional text of the diff

• optional string url = 2

  Specifies the URL to the diff

Used in: Component

• repeated LicenseChoice licenses = 1

• repeated EvidenceCopyright copyright = 2

Used in: Evidence

• string text = 1

  Copyright text

Used in: Bom, Component, Service

• ExternalReferenceType type = 1

  Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.

• string url = 2

  The URL to the external reference

• optional string comment = 3

  An optional comment describing the external reference

• repeated Hash hashes = 4

  Optional integrity hashes for the external resource content

Used in: ExternalReference

• EXTERNAL_REFERENCE_TYPE_OTHER = 0

  Use this if no other types accurately describe the purpose of the external reference

• EXTERNAL_REFERENCE_TYPE_VCS = 1

  Version Control System

• EXTERNAL_REFERENCE_TYPE_ISSUE_TRACKER = 2

  Issue or defect tracking system, or an Application Lifecycle Management (ALM) system

• EXTERNAL_REFERENCE_TYPE_WEBSITE = 3

  Website

• EXTERNAL_REFERENCE_TYPE_ADVISORIES = 4

  Security advisories

• EXTERNAL_REFERENCE_TYPE_BOM = 5

  Bill-of-material document (CycloneDX, SPDX, SWID, etc)

• EXTERNAL_REFERENCE_TYPE_MAILING_LIST = 6

  Mailing list or discussion group

• EXTERNAL_REFERENCE_TYPE_SOCIAL = 7

  Social media account

• EXTERNAL_REFERENCE_TYPE_CHAT = 8

  Real-time chat platform

• EXTERNAL_REFERENCE_TYPE_DOCUMENTATION = 9

  Documentation, guides, or how-to instructions

• EXTERNAL_REFERENCE_TYPE_SUPPORT = 10

  Community or commercial support

• EXTERNAL_REFERENCE_TYPE_DISTRIBUTION = 11

  Direct or repository download location

• EXTERNAL_REFERENCE_TYPE_LICENSE = 12

  The URL to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness

• EXTERNAL_REFERENCE_TYPE_BUILD_META = 13

  Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)

• EXTERNAL_REFERENCE_TYPE_BUILD_SYSTEM = 14

  URL to an automated build system

Specifies the file hash of the component

Used in: Component, ExternalReference, Tool

• HashAlg alg = 1

  Specifies the algorithm used to create the hash

• string value = 2

  SimpleContent value of element

Used in: Hash

• HASH_ALG_NULL = 0

• HASH_ALG_MD_5 = 1

• HASH_ALG_SHA_1 = 2

• HASH_ALG_SHA_256 = 3

• HASH_ALG_SHA_384 = 4

• HASH_ALG_SHA_512 = 5

• HASH_ALG_SHA_3_256 = 6

• HASH_ALG_SHA_3_384 = 7

• HASH_ALG_SHA_3_512 = 8

• HASH_ALG_BLAKE_2_B_256 = 9

• HASH_ALG_BLAKE_2_B_384 = 10

• HASH_ALG_BLAKE_2_B_512 = 11

• HASH_ALG_BLAKE_3 = 12

Used in: Commit

• optional google.protobuf.Timestamp timestamp = 1

  The timestamp in which the action occurred

• optional string name = 2

  The name of the individual who performed the action

• optional string email = 3

  The email address of the individual who performed the action

Used in: Patch

• IssueClassification type = 1

  Specifies the type of issue

• optional string id = 2

  The identifier of the issue assigned by the source of the issue

• optional string name = 3

  The name of the issue

• optional string description = 4

  A description of the issue

• optional Source source = 5

• repeated string references = 6

Used in: Issue

• ISSUE_CLASSIFICATION_NULL = 0

• ISSUE_CLASSIFICATION_DEFECT = 1

  A fault, flaw, or bug in software

• ISSUE_CLASSIFICATION_ENHANCEMENT = 2

  A new feature or behavior in software

• ISSUE_CLASSIFICATION_SECURITY = 3

  A special type of defect which impacts security

Used in: LicenseChoice

• oneof license

  • string id = 1

    A valid SPDX license ID

  • string name = 2

    If SPDX does not define the license used, this field may be used to provide the license name

• optional AttachedText text = 3

  Specifies the optional full text of the attachment

• optional string url = 4

  The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be specified for completeness.

Used in: Component, Evidence, Metadata, Service

• oneof choice

  • License license = 1

  • string expression = 2

Used in: Bom

• optional google.protobuf.Timestamp timestamp = 1

  The date and time (timestamp) when the document was created.

• repeated Tool tools = 2

  The tool(s) used in the creation of the BOM.

• repeated OrganizationalContact authors = 3

  The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.

• optional Component component = 4

  The component that the BOM describes.

• optional OrganizationalEntity manufacture = 5

  The organization that manufactured the component that the BOM describes.

• optional OrganizationalEntity supplier = 6

  The organization that supplied the component that the BOM describes. The supplier may often be the manufacture, but may also be a distributor or repackager.

• optional LicenseChoice licenses = 7

  The license information for the BOM document

• repeated Property properties = 8

  Specifies optional, custom, properties

Used in: Metadata, OrganizationalEntity

• optional string name = 1

  The name of the contact

• optional string email = 2

  The email address of the contact.

• optional string phone = 3

  The phone number of the contact.

Used in: Component, Metadata, Service

• optional string name = 1

  The name of the organization

• repeated string url = 2

  The URL of the organization. Multiple URLs are allowed.

• repeated OrganizationalContact contact = 3

  A contact person at the organization. Multiple contacts are allowed.

Used in: Pedigree

• PatchClassification type = 1

  Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality

• optional Diff diff = 2

  The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff

• repeated Issue resolves = 3

Used in: Patch

• PATCH_CLASSIFICATION_NULL = 0

• PATCH_CLASSIFICATION_UNOFFICIAL = 1

  A patch which is not developed by the creators or maintainers of the software being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch

• PATCH_CLASSIFICATION_MONKEY = 2

  A patch which dynamically modifies runtime behavior. Refer to https://en.wikipedia.org/wiki/Monkey_patch

• PATCH_CLASSIFICATION_BACKPORT = 3

  A patch which takes code from a newer version of software and applies it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting

• PATCH_CLASSIFICATION_CHERRY_PICK = 4

  A patch created by selectively applying commits from other versions or branches of the same software.

Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.

Used in: Component

• repeated Component ancestors = 1

  Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.

• repeated Component descendants = 2

  Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.

• repeated Component variants = 3

  Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.

• repeated Commit commits = 4

  A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.

• repeated Patch patches = 5

  A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.

• optional string notes = 6

  Notes, observations, and other non-structured commentary describing the components pedigree.

Specifies a property

Used in: Component, Metadata, Service

• string name = 1

• optional string value = 2

Used in: Component

• SCOPE_UNSPECIFIED = 0

  Default

• SCOPE_REQUIRED = 1

  The component is required for runtime

• SCOPE_OPTIONAL = 2

  The component is optional at runtime. Optional components are components that are not capable of being called due to them not be installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'.

• SCOPE_EXCLUDED = 3

  Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime.

Used in: Bom

• optional string bom_ref = 1

  An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

• optional OrganizationalEntity provider = 2

  The organization that provides the service.

• optional string group = 3

  The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.

• string name = 4

  The name of the service. This will often be a shortened, single name of the service.

• optional string version = 5

  The service version.

• optional string description = 6

  Specifies a description for the service.

• repeated string endpoints = 7

• optional bool authenticated = 8

  A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.

• optional bool x_trust_boundary = 9

  A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.

• repeated DataClassification data = 10

• repeated LicenseChoice licenses = 11

• repeated ExternalReference external_references = 12

  Provides the ability to document external references related to the service.

• repeated Service services = 13

  Specifies optional sub-service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.

• repeated Property properties = 14

  Specifies optional, custom, properties

The source of the issue where it is documented.

Used in: Issue

• optional string name = 1

  The name of the source. For example "National Vulnerability Database", "NVD", and "Apache"

• optional string url = 2

  The url of the issue documentation as provided by the source

Used in: Component

• string tag_id = 1

  Maps to the tagId of a SoftwareIdentity.

• string name = 2

  Maps to the name of a SoftwareIdentity.

• optional string version = 3

  Maps to the version of a SoftwareIdentity.

• optional int32 tag_version = 4

  Maps to the tagVersion of a SoftwareIdentity.

• optional bool patch = 5

  Maps to the patch of a SoftwareIdentity.

• optional AttachedText text = 6

  Specifies the full content of the SWID tag.

• optional string url = 7

  The URL to the SWID file.

Specifies a tool (manual or automated).

Used in: Metadata

• optional string vendor = 1

  The vendor of the tool used to create the BOM.

• optional string name = 2

  The name of the tool used to create the BOM.

• optional string version = 3

  The version of the tool used to create the BOM.

• repeated Hash hashes = 4