be504b000d
When support for SPDX 2.3 was added, it effectively dropped support for SPDX 2.2, which in retrospect was a bad idea since SPDX 2.2 is the version that is the current ISO/IEC standard. This commit adds a `--spdx-version` option to the `west spdx` command so that users can generate SPDX 2.2 documents if they want. Default is 2.3 given that's effectively what shipped for a few releases now, including latest LTS. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
216 lines
7.4 KiB
Python
216 lines
7.4 KiB
Python
# Copyright (c) 2020, 2021 The Linux Foundation
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
import re
|
|
from datetime import datetime
|
|
|
|
from west import log
|
|
|
|
from zspdx.util import getHashes
|
|
from zspdx.version import SPDX_VERSION_2_3
|
|
|
|
CPE23TYPE_REGEX = (
|
|
r'^cpe:2\.3:[aho\*\-](:(((\?*|\*?)([a-zA-Z0-9\-\._]|(\\[\\\*\?!"#$$%&\'\(\)\+,\/:;<=>@\[\]\^'
|
|
r"`\{\|}~]))+(\?*|\*?))|[\*\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[\*\-]))(:(((\?*"
|
|
r'|\*?)([a-zA-Z0-9\-\._]|(\\[\\\*\?!"#$$%&\'\(\)\+,\/:;<=>@\[\]\^`\{\|}~]))+(\?*|\*?))|[\*\-])){4}$'
|
|
)
|
|
PURL_REGEX = r"^pkg:.+(\/.+)?\/.+(@.+)?(\?.+)?(#.+)?$"
|
|
|
|
def _normalize_spdx_name(name):
|
|
# Replace "_" by "-" since it's not allowed in spdx ID
|
|
return name.replace("_", "-")
|
|
|
|
# Output tag-value SPDX 2.3 content for the given Relationship object.
|
|
# Arguments:
|
|
# 1) f: file handle for SPDX document
|
|
# 2) rln: Relationship object being described
|
|
def writeRelationshipSPDX(f, rln):
|
|
f.write(
|
|
f"Relationship: {_normalize_spdx_name(rln.refA)} {rln.rlnType} "
|
|
f"{_normalize_spdx_name(rln.refB)}\n"
|
|
)
|
|
|
|
# Output tag-value SPDX 2.3 content for the given File object.
|
|
# Arguments:
|
|
# 1) f: file handle for SPDX document
|
|
# 2) bf: File object being described
|
|
def writeFileSPDX(f, bf):
|
|
spdx_normalize_spdx_id = _normalize_spdx_name(bf.spdxID)
|
|
|
|
f.write(f"""FileName: ./{bf.relpath}
|
|
SPDXID: {spdx_normalize_spdx_id}
|
|
FileChecksum: SHA1: {bf.sha1}
|
|
""")
|
|
if bf.sha256 != "":
|
|
f.write(f"FileChecksum: SHA256: {bf.sha256}\n")
|
|
if bf.md5 != "":
|
|
f.write(f"FileChecksum: MD5: {bf.md5}\n")
|
|
f.write(f"LicenseConcluded: {bf.concludedLicense}\n")
|
|
if len(bf.licenseInfoInFile) == 0:
|
|
f.write("LicenseInfoInFile: NONE\n")
|
|
else:
|
|
for licInfoInFile in bf.licenseInfoInFile:
|
|
f.write(f"LicenseInfoInFile: {licInfoInFile}\n")
|
|
f.write(f"FileCopyrightText: {bf.copyrightText}\n\n")
|
|
|
|
# write file relationships
|
|
if len(bf.rlns) > 0:
|
|
for rln in bf.rlns:
|
|
writeRelationshipSPDX(f, rln)
|
|
f.write("\n")
|
|
|
|
def generateDowloadUrl(url, revision):
|
|
# Only git is supported
|
|
# walker.py only parse revision if it's from git repositiory
|
|
if len(revision) == 0:
|
|
return url
|
|
|
|
return f'git+{url}@{revision}'
|
|
|
|
# Output tag-value SPDX content for the given Package object.
|
|
# Arguments:
|
|
# 1) f: file handle for SPDX document
|
|
# 2) pkg: Package object being described
|
|
# 3) spdx_version: SPDX specification version
|
|
def writePackageSPDX(f, pkg, spdx_version=SPDX_VERSION_2_3):
|
|
spdx_normalized_name = _normalize_spdx_name(pkg.cfg.name)
|
|
spdx_normalize_spdx_id = _normalize_spdx_name(pkg.cfg.spdxID)
|
|
|
|
f.write(f"""##### Package: {spdx_normalized_name}
|
|
|
|
PackageName: {spdx_normalized_name}
|
|
SPDXID: {spdx_normalize_spdx_id}
|
|
PackageLicenseConcluded: {pkg.concludedLicense}
|
|
""")
|
|
f.write(f"""PackageLicenseDeclared: {pkg.cfg.declaredLicense}
|
|
PackageCopyrightText: {pkg.cfg.copyrightText}
|
|
""")
|
|
|
|
# PrimaryPackagePurpose is only available in SPDX 2.3 and later
|
|
if spdx_version >= SPDX_VERSION_2_3 and pkg.cfg.primaryPurpose != "":
|
|
f.write(f"PrimaryPackagePurpose: {pkg.cfg.primaryPurpose}\n")
|
|
|
|
if len(pkg.cfg.url) > 0:
|
|
downloadUrl = generateDowloadUrl(pkg.cfg.url, pkg.cfg.revision)
|
|
f.write(f"PackageDownloadLocation: {downloadUrl}\n")
|
|
else:
|
|
f.write("PackageDownloadLocation: NOASSERTION\n")
|
|
|
|
if len(pkg.cfg.version) > 0:
|
|
f.write(f"PackageVersion: {pkg.cfg.version}\n")
|
|
elif len(pkg.cfg.revision) > 0:
|
|
f.write(f"PackageVersion: {pkg.cfg.revision}\n")
|
|
|
|
for ref in pkg.cfg.externalReferences:
|
|
if re.fullmatch(CPE23TYPE_REGEX, ref):
|
|
f.write(f"ExternalRef: SECURITY cpe23Type {ref}\n")
|
|
elif re.fullmatch(PURL_REGEX, ref):
|
|
f.write(f"ExternalRef: PACKAGE_MANAGER purl {ref}\n")
|
|
else:
|
|
log.wrn(f"Unknown external reference ({ref})")
|
|
|
|
# flag whether files analyzed / any files present
|
|
if len(pkg.files) > 0:
|
|
if len(pkg.licenseInfoFromFiles) > 0:
|
|
for licFromFiles in pkg.licenseInfoFromFiles:
|
|
f.write(f"PackageLicenseInfoFromFiles: {licFromFiles}\n")
|
|
else:
|
|
f.write("PackageLicenseInfoFromFiles: NOASSERTION\n")
|
|
f.write(f"FilesAnalyzed: true\nPackageVerificationCode: {pkg.verificationCode}\n\n")
|
|
else:
|
|
f.write("FilesAnalyzed: false\nPackageComment: Utility target; no files\n\n")
|
|
|
|
# write package relationships
|
|
if len(pkg.rlns) > 0:
|
|
for rln in pkg.rlns:
|
|
writeRelationshipSPDX(f, rln)
|
|
f.write("\n")
|
|
|
|
# write package files, if any
|
|
if len(pkg.files) > 0:
|
|
bfs = list(pkg.files.values())
|
|
bfs.sort(key = lambda x: x.relpath)
|
|
for bf in bfs:
|
|
writeFileSPDX(f, bf)
|
|
|
|
# Output tag-value SPDX 2.3 content for a custom license.
|
|
# Arguments:
|
|
# 1) f: file handle for SPDX document
|
|
# 2) lic: custom license ID being described
|
|
def writeOtherLicenseSPDX(f, lic):
|
|
f.write(f"""LicenseID: {lic}
|
|
ExtractedText: {lic}
|
|
LicenseName: {lic}
|
|
LicenseComment: Corresponds to the license ID `{lic}` detected in an SPDX-License-Identifier: tag.
|
|
""")
|
|
|
|
# Output tag-value SPDX content for the given Document object.
|
|
# Arguments:
|
|
# 1) f: file handle for SPDX document
|
|
# 2) doc: Document object being described
|
|
# 3) spdx_version: SPDX specification version
|
|
def writeDocumentSPDX(f, doc, spdx_version=SPDX_VERSION_2_3):
|
|
spdx_normalized_name = _normalize_spdx_name(doc.cfg.name)
|
|
|
|
f.write(f"""SPDXVersion: SPDX-{spdx_version}
|
|
DataLicense: CC0-1.0
|
|
SPDXID: SPDXRef-DOCUMENT
|
|
DocumentName: {spdx_normalized_name}
|
|
DocumentNamespace: {doc.cfg.namespace}
|
|
Creator: Tool: Zephyr SPDX builder
|
|
Created: {datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")}
|
|
|
|
""")
|
|
|
|
# write any external document references
|
|
if len(doc.externalDocuments) > 0:
|
|
extDocs = list(doc.externalDocuments)
|
|
extDocs.sort(key = lambda x: x.cfg.docRefID)
|
|
for extDoc in extDocs:
|
|
f.write(
|
|
f"ExternalDocumentRef: {extDoc.cfg.docRefID} {extDoc.cfg.namespace} "
|
|
f"SHA1: {extDoc.myDocSHA1}\n"
|
|
)
|
|
f.write("\n")
|
|
|
|
# write relationships owned by this Document (not by its Packages, etc.), if any
|
|
if len(doc.relationships) > 0:
|
|
for rln in doc.relationships:
|
|
writeRelationshipSPDX(f, rln)
|
|
f.write("\n")
|
|
|
|
# write packages
|
|
for pkg in doc.pkgs.values():
|
|
writePackageSPDX(f, pkg, spdx_version)
|
|
|
|
# write other license info, if any
|
|
if len(doc.customLicenseIDs) > 0:
|
|
for lic in sorted(list(doc.customLicenseIDs)):
|
|
writeOtherLicenseSPDX(f, lic)
|
|
|
|
# Open SPDX document file for writing, write the document, and calculate
|
|
# its hash for other referring documents to use.
|
|
# Arguments:
|
|
# 1) spdxPath: path to write SPDX document
|
|
# 2) doc: SPDX Document object to write
|
|
# 3) spdx_version: SPDX specification version
|
|
def writeSPDX(spdxPath, doc, spdx_version=SPDX_VERSION_2_3):
|
|
# create and write document to disk
|
|
try:
|
|
log.inf(f"Writing SPDX {spdx_version} document {doc.cfg.name} to {spdxPath}")
|
|
with open(spdxPath, "w") as f:
|
|
writeDocumentSPDX(f, doc, spdx_version)
|
|
except OSError as e:
|
|
log.err(f"Error: Unable to write to {spdxPath}: {str(e)}")
|
|
return False
|
|
|
|
# calculate hash of the document we just wrote
|
|
hashes = getHashes(spdxPath)
|
|
if not hashes:
|
|
log.err("Error: created document but unable to calculate hash values")
|
|
return False
|
|
doc.myDocSHA1 = hashes[0]
|
|
|
|
return True
|