spdx_tools.spdx.model.package

  1# SPDX-FileCopyrightText: 2022 spdx contributors
  2#
  3# SPDX-License-Identifier: Apache-2.0
  4from dataclasses import field
  5from datetime import datetime
  6from enum import Enum, auto
  7
  8from beartype.typing import Dict, List, Optional, Union
  9from license_expression import LicenseExpression
 10
 11from spdx_tools.common.typing.dataclass_with_properties import dataclass_with_properties
 12from spdx_tools.common.typing.type_checks import check_types_and_set_values
 13from spdx_tools.spdx.model import Actor, Checksum, SpdxNoAssertion, SpdxNone
 14
 15
 16class PackagePurpose(Enum):
 17    APPLICATION = auto()
 18    FRAMEWORK = auto()
 19    LIBRARY = auto()
 20    CONTAINER = auto()
 21    OPERATING_SYSTEM = auto()
 22    DEVICE = auto()
 23    FIRMWARE = auto()
 24    SOURCE = auto()
 25    ARCHIVE = auto()
 26    FILE = auto()
 27    INSTALL = auto()
 28    OTHER = auto()
 29
 30
 31@dataclass_with_properties
 32class PackageVerificationCode:
 33    value: str
 34    excluded_files: List[str] = field(default_factory=list)
 35
 36    def __init__(self, value: str, excluded_files: List[str] = None):
 37        excluded_files = [] if excluded_files is None else excluded_files
 38        check_types_and_set_values(self, locals())
 39
 40
 41class ExternalPackageRefCategory(Enum):
 42    SECURITY = auto()
 43    PACKAGE_MANAGER = auto()
 44    PERSISTENT_ID = auto()
 45    OTHER = auto()
 46
 47
 48CATEGORY_TO_EXTERNAL_PACKAGE_REF_TYPES: Dict[ExternalPackageRefCategory, List[str]] = {
 49    ExternalPackageRefCategory.SECURITY: ["cpe22Type", "cpe23Type", "advisory", "fix", "url", "swid"],
 50    ExternalPackageRefCategory.PACKAGE_MANAGER: ["maven-central", "npm", "nuget", "bower", "purl"],
 51    ExternalPackageRefCategory.PERSISTENT_ID: ["swh", "gitoid"],
 52    ExternalPackageRefCategory.OTHER: [],
 53}
 54
 55
 56@dataclass_with_properties
 57class ExternalPackageRef:
 58    category: ExternalPackageRefCategory
 59    # In theory, once could refine the typing,
 60    # see https://spdx.github.io/spdx-spec/v2.3/external-repository-identifiers/. But it's probably not worth the
 61    # effort.
 62    reference_type: str
 63    locator: str
 64    comment: Optional[str] = None
 65
 66    def __init__(
 67        self, category: ExternalPackageRefCategory, reference_type: str, locator: str, comment: Optional[str] = None
 68    ):
 69        check_types_and_set_values(self, locals())
 70
 71
 72@dataclass_with_properties
 73class Package:
 74    spdx_id: str
 75    name: str
 76    download_location: Union[str, SpdxNoAssertion, SpdxNone]
 77    version: Optional[str] = None
 78    file_name: Optional[str] = None
 79    supplier: Optional[Union[Actor, SpdxNoAssertion]] = None
 80    originator: Optional[Union[Actor, SpdxNoAssertion]] = None
 81    files_analyzed: bool = True
 82    verification_code: Optional[PackageVerificationCode] = None
 83    checksums: List[Checksum] = field(default_factory=list)
 84    homepage: Optional[Union[str, SpdxNoAssertion, SpdxNone]] = None
 85    source_info: Optional[str] = None
 86    license_concluded: Optional[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None
 87    license_info_from_files: List[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = field(default_factory=list)
 88    license_declared: Optional[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None
 89    license_comment: Optional[str] = None
 90    copyright_text: Optional[Union[str, SpdxNoAssertion, SpdxNone]] = None
 91    summary: Optional[str] = None
 92    description: Optional[str] = None
 93    comment: Optional[str] = None
 94    external_references: List[ExternalPackageRef] = field(default_factory=list)
 95    attribution_texts: List[str] = field(default_factory=list)
 96    primary_package_purpose: Optional[PackagePurpose] = None
 97    release_date: Optional[datetime] = None
 98    built_date: Optional[datetime] = None
 99    valid_until_date: Optional[datetime] = None
100
101    def __init__(
102        self,
103        spdx_id: str,
104        name: str,
105        download_location: Union[str, SpdxNoAssertion, SpdxNone],
106        version: Optional[str] = None,
107        file_name: Optional[str] = None,
108        supplier: Optional[Union[Actor, SpdxNoAssertion]] = None,
109        originator: Optional[Union[Actor, SpdxNoAssertion]] = None,
110        files_analyzed: bool = True,
111        verification_code: Optional[PackageVerificationCode] = None,
112        checksums: List[Checksum] = None,
113        homepage: Optional[Union[str, SpdxNoAssertion, SpdxNone]] = None,
114        source_info: Optional[str] = None,
115        license_concluded: Optional[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None,
116        license_info_from_files: List[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None,
117        license_declared: Optional[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None,
118        license_comment: Optional[str] = None,
119        copyright_text: Optional[Union[str, SpdxNoAssertion, SpdxNone]] = None,
120        summary: Optional[str] = None,
121        description: Optional[str] = None,
122        comment: Optional[str] = None,
123        external_references: List[ExternalPackageRef] = None,
124        attribution_texts: List[str] = None,
125        primary_package_purpose: Optional[PackagePurpose] = None,
126        release_date: Optional[datetime] = None,
127        built_date: Optional[datetime] = None,
128        valid_until_date: Optional[datetime] = None,
129    ):
130        checksums = [] if checksums is None else checksums
131        license_info_from_files = [] if license_info_from_files is None else license_info_from_files
132        external_references = [] if external_references is None else external_references
133        attribution_texts = [] if attribution_texts is None else attribution_texts
134        check_types_and_set_values(self, locals())