csspin-tooling 1.0.0rc1__py3-none-any.whl

csspin_tooling/__init__.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2026 CONTACT Software GmbH
+# https://www.contact-software.com/
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File needed for _utils.py to be imported.

csspin_tooling/sbomasm.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2026 CONTACT Software GmbH
+# https://www.contact-software.com/
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module implementing the SBOM assembly and enrichment plugin for spin."""
+
+from __future__ import annotations
+
+import email.utils
+import sys
+from tempfile import TemporaryDirectory
+
+from csspin import (
+    backtick,
+    config,
+    die,
+    download,
+    exists,
+    extract,
+    group,
+    info,
+)
+from csspin.tree import ConfigTree
+from csspin_python.python import get_project_metadata
+from path import Path
+
+defaults = config(
+    version="2.0.3",
+    install_dir="{spin.data}/sbomasm",
+    use=None,
+    output_file="{spin.project_name}.cdx.json",
+    format=config(spec="cyclonedx", version="1.6"),
+    requires=config(spin=["csspin_python.python"]),
+)
+
+
+def provision(cfg: ConfigTree) -> None:
+    """Provision the plugin"""
+    if not cfg.sbomasm.use:
+        _provision_sbomasm(cfg)
+
+
+@group()
+def sbomasm(cfg: ConfigTree) -> None:  # pylint: disable=unused-argument
+    """sbomasm-based SBOM assembly and enrichment."""
+
+
+@sbomasm.task(when="sbom:assemble")
+def assemble(cfg: ConfigTree) -> None:
+    """Merge the top-level SBOMs into a single one (no enrichment)."""
+    _assemble_sbom(cfg)
+
+
+@sbomasm.task(when="sbom:enrich")
+def enrich(cfg: ConfigTree) -> None:
+    """Enrich the assembled SBOM with project metadata."""
+    _enrich_sbom(cfg)
+
+
+# -- Internals -----------------------------------------------------------------
+def _provision_sbomasm(cfg: ConfigTree) -> None:
+    """Downloads sbomasm"""
+    version = cfg.sbomasm.version
+    sbomasm_install_dir = cfg.sbomasm.install_dir / version
+
+    if exists(sbomasm_install_dir / f"sbomasm{cfg.platform.exe}"):
+        info(f"Using cached sbomasm ({sbomasm_install_dir})")
+        return
+
+    info("Installing sbomasm")
+    archive = (
+        f"sbomasm_{version}_Windows_x86_64.tar.gz"
+        if sys.platform == "win32"
+        else f"sbomasm_{version}_Linux_x86_64.tar.gz"
+    )
+
+    with TemporaryDirectory() as tmp_dir:
+        archive_path = Path(tmp_dir) / archive
+        download(
+            f"https://github.com/interlynk-io/sbomasm/releases/download/v{version}/{archive}",
+            archive_path,
+        )
+        extract(archive_path, sbomasm_install_dir, f"sbomasm{cfg.platform.exe}")
+
+
+def _sbomasm_binary(cfg: ConfigTree) -> Path:
+    """Return the path to the sbomasm binary to use."""
+    if cfg.sbomasm.use:
+        return Path(cfg.sbomasm.use)
+    return cfg.sbomasm.install_dir / cfg.sbomasm.version / f"sbomasm{cfg.platform.exe}"
+
+
+def _assemble_sbom(cfg: ConfigTree) -> None:
+    """Merge SBOMs in the working directory into ``cfg.sbomasm.output_file``.
+
+    With a single input, the file is copied through unchanged — ``sbomasm
+    assemble`` rejects single-input invocations. Enrichment is handled
+    separately by :func:`_enrich_sbom`.
+    """
+    output = Path(cfg.sbomasm.output_file)
+    sboms = {path for path in Path().glob("*.cdx.json") if output != path}
+    info(f"Found {len(sboms)} SBOM(s) to assemble: {[str(p) for p in sboms]}")
+
+    if not sboms:
+        die("No SBOMs found to assemble.")
+        return
+
+    if len(sboms) == 1:
+        single_sbom = sboms.pop()
+        output.write_text(single_sbom.read_text(encoding="utf-8"), encoding="utf-8")
+        info(f"Single SBOM {single_sbom} copied to {output}")
+        return
+
+    metadata = get_project_metadata(cfg.spin.project_root, cfg.python.index_url)
+    args = [
+        str(_sbomasm_binary(cfg)),
+        "assemble",
+        "-m",
+        "-n",
+        metadata.get("name", "unknown"),
+        "-v",
+        metadata.get("version", "0.0.0"),
+        "-t",
+        "application",
+        "-e",
+        cfg.sbomasm.format.version,
+    ]
+    if cfg.sbomasm.format.spec.lower() == "spdx":
+        args.append("-s")
+    args.extend(str(p) for p in sboms)
+
+    sbom_text = backtick(*args)
+    output.write_text(sbom_text, encoding="utf-8")
+    info(f"Merged {len(sboms)} SBOMs into {output}")
+
+
+def _enrich_sbom(cfg: ConfigTree) -> None:
+    """Enrich ``cfg.sbomasm.output_file`` in place via ``sbomasm edit``."""
+    output = Path(cfg.sbomasm.output_file)
+    if not exists(output):
+        die(f"Cannot enrich {output}: file does not exist.")
+
+    metadata = get_project_metadata(cfg.spin.project_root, cfg.python.index_url)
+
+    if not (name := metadata.get("name")):
+        die("Project metadata is missing 'name'.")
+    if not (version := metadata.get("version")):
+        die("Project metadata is missing 'version'.")
+    if not (license_id := metadata.get("license")):
+        die("Project metadata is missing 'license'.")
+
+    authors = _parse_authors(
+        author_name=metadata.get("author", "").strip(),
+        author_email=metadata.get("author_email", "").strip(),
+    )
+
+    args = [
+        str(_sbomasm_binary(cfg)),
+        "edit",
+        "--subject",
+        "primary-component",
+        "--name",
+        name,
+        "--version",
+        version,
+        "--author",
+        authors,
+        "--license",
+        license_id,
+        str(output),
+    ]
+
+    info(f"Enriching SBOM {output}")
+    sbom_text = backtick(*args)
+    output.write_text(sbom_text, encoding="utf-8")
+    info(f"Enriched SBOM written to {output}")
+
+
+def _parse_authors(author_name: str, author_email: str) -> str:
+    """
+    Parse RFC 2822 Author-email metadata and return a comma-separated string in
+    sbomasm-acceptable format ('name (email)' or multiple authors,
+    comma-separated).
+    """
+    if not author_email:
+        die("Project metadata has no Author-email field.")
+        return ""
+
+    entries = email.utils.getaddresses([author_email])
+
+    # setup.py case: single bare address paired with a separate Author field
+    if len(entries) == 1 and not entries[0][0] and author_name:
+        entries = [(author_name, entries[0][1])]
+
+    for name, addr in entries:
+        if not name:
+            die(f"Author entry '{addr}' has no name; all authors require a name.")
+            return ""
+        if not addr:
+            die(f"Author entry '{name}' has no email; all authors require an email.")
+            return ""
+
+    return ", ".join(f"{name} ({addr})" for name, addr in entries)

csspin_tooling/sbomasm_schema.yaml

@@ -0,0 +1,35 @@
+# -*- mode: yaml; coding: utf-8 -*-
+#
+# Schema for the sbomasm plugin for spin
+
+sbomasm:
+  type: object
+  help: |
+    The sbomasm plugin wraps around the sbomasm tool for for assembling and
+    enriching SBOMs.
+  properties:
+    version:
+      type: str
+      help: Version of sbomasm to use
+    install_dir:
+      type: path
+      help: The installation directory to install sbomasm versions into
+    use:
+      type: path
+      help: |
+        Can be used to specify a custom sbomasm binary to use instead of the one
+        installed by the plugin
+    output_file:
+      type: path
+      help: The file path to write the generated SBOM to
+    format:
+      type: object
+      help: Configuration regarding the output format of the generated SBOM
+      properties:
+        name:
+          type: str
+          help: |
+            The name of the output format to use
+        version:
+          type: str
+          help: The version of the output format to use

csspin_tooling-1.0.0rc1.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: csspin-tooling
+Version: 1.0.0rc1
+Summary: Plugin-package for csspin providing common tooling for csspin-based projects
+Author-email: CONTACT Software GmbH <info@contact-software.com>
+Maintainer-email: Benjamin Thomas Schwertfeger <benjaminthomas.schwertfeger@contact-software.com>, Fabian Hafer <fabian.hafer@contact-software.com>, Waleri Enns <waleri.enns@contact-software.com>
+License-Expression: Apache-2.0
+Project-URL: CONTACT Software GmbH, https://contact-software.com
+Project-URL: Documentation, https://csspin-tooling.readthedocs.io/en/stable/
+Project-URL: Issue Tracker, https://github.com/cslab/csspin-tooling/issues
+Project-URL: Release Notes, https://csspin-tooling.readthedocs.io/en/stable/relnotes.html
+Project-URL: Repository, https://github.com/cslab/csspin-tooling
+Classifier: Environment :: Console
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: csspin-python
+Dynamic: license-file
+
+``csspin-tooling`` is maintained by `CONTACT Software GmbH`_ and provides
+utility plugins and tasks to be used with the `csspin`_ task runner.
+
+The following plugins are available:
+
+- ``csspin_tooling.sbomasm``: Assembles multiple CycloneDX SBOM files into a
+  single enriched top-level SBOM using the `sbomasm`_ tool.
+
+Prerequisites
+-------------
+
+`csspin`_ must be installed before using this package:
+
+.. code-block:: console
+
+   python -m pip install csspin
+
+Using csspin-tooling
+--------------------
+
+Add the package and the desired plugins to your project's ``spinfile.yaml``:
+
+.. code-block:: yaml
+
+    spin:
+      project_name: my_project
+
+    plugin_packages:
+      - csspin-python
+      - csspin-tooling
+
+    plugins:
+      - csspin_tooling.sbomasm
+
+    python:
+      version: "3.11.9"
+
+Provision the project to download sbomasm and install all dependencies:
+
+.. code-block:: console
+
+   spin provision
+
+Assemble a top-level SBOM from all ``*.cdx.json`` files in the project root:
+
+.. code-block:: console
+
+   spin sbom --help
+
+.. _`CONTACT Software GmbH`: https://contact-software.com
+.. _`csspin`: https://pypi.org/project/csspin
+.. _`sbomasm`: https://github.com/interlynk-io/sbomasm

csspin_tooling-1.0.0rc1.dist-info/RECORD

@@ -0,0 +1,8 @@
+csspin_tooling/__init__.py,sha256=_aend_LjiCh_wXpo6X9YU9_BFxqx9I8JpSJA2GLrq6k,696
+csspin_tooling/sbomasm.py,sha256=xd4bwqoS1fzG1iEI7L0IVIZFxhAM6aLyfPBtGs11TmU,6719
+csspin_tooling/sbomasm_schema.yaml,sha256=uM70fuLToFZ85F0YVcTiHhWjoTzggI6qLILL8wjCFFA,961
+csspin_tooling-1.0.0rc1.dist-info/licenses/LICENSE,sha256=4MAecetnRTQw5DlHtiikDSzKWO1xVLwzM5_DsPMYlnE,10172
+csspin_tooling-1.0.0rc1.dist-info/METADATA,sha256=GDqTr6Zwht2WkC0jJrbx3CbKCtfR4kcnEqay1TAekHk,2669
+csspin_tooling-1.0.0rc1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+csspin_tooling-1.0.0rc1.dist-info/top_level.txt,sha256=84uiKmEci5TW1HewSfGKdOvTX5-BP6ElnP3W9p7VIbE,15
+csspin_tooling-1.0.0rc1.dist-info/RECORD,,

csspin_tooling-1.0.0rc1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

csspin_tooling-1.0.0rc1.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

csspin_tooling-1.0.0rc1.dist-info/top_level.txt

@@ -0,0 +1 @@
+csspin_tooling