cdx-proto
    Preparing search index...

    Type Alias License

    License: Message<"cyclonedx.v1_6.License"> & {
        acknowledgement?: LicenseAcknowledgementEnumeration;
        bomRef?: string;
        license:
            | { case: "id"; value: string }
            | { case: "name"; value: string }
            | { case: undefined; value?: undefined };
        licensing?: Licensing;
        properties: Property[];
        text?: AttachedText;
        url?: string;
    }

    Type declaration

    • Optionalacknowledgement?: LicenseAcknowledgementEnumeration

      Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.

      from field: optional cyclonedx.v1_6.LicenseAcknowledgementEnumeration acknowledgement = 8;

    • OptionalbomRef?: string

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

      from field: optional string bom_ref = 5;

    • license:
          | { case: "id"; value: string }
          | { case: "name"; value: string }
          | { case: undefined; value?: undefined }

      from oneof cyclonedx.v1_6.License.license

    • Optionallicensing?: Licensing

      Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata

      from field: optional cyclonedx.v1_6.Licensing licensing = 6;

    • properties: Property[]

      Specifies optional, custom, properties

      from field: repeated cyclonedx.v1_6.Property properties = 7;

    • Optionaltext?: AttachedText

      Specifies the optional full text of the attachment

      from field: optional cyclonedx.v1_6.AttachedText text = 3;

    • Optionalurl?: string

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

      from field: optional string url = 4;

    from message cyclonedx.v1_6.License