novabucks 0.1.0__tar.gz

novabucks-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.

novabucks-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: novabucks
+Version: 0.1.0
+Summary: CLI tool for signing Maven artifacts
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: defusedxml>=0.7.0
+Requires-Dist: jinja2>=3.0
+Requires-Dist: oras>=0.1.0
+Requires-Dist: python-qpid-proton>=0.31.0
+Dynamic: license-file

novabucks-0.1.0/README.md

@@ -0,0 +1,188 @@
+# novabucks
+
+CLI tool for signing Maven artifacts through the RADAS signing service.
+
+## Requirements
+
+- Python 3.11+
+
+## Installation
+
+Install the package in editable mode:
+
+```bash
+pip install -e .
+```
+
+For development (includes pytest, ruff, etc.):
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Dependencies
+
+| Package | Purpose |
+|---------|---------|
+| `click` | CLI framework |
+| `defusedxml` | Secure XML parsing |
+| `jinja2` | Maven metadata templating |
+| `oras` | OCI Registry as Storage client |
+| `python-qpid-proton` | AMQP messaging for UMB |
+
+## Usage
+
+```bash
+novabucks --version
+novabucks --help
+```
+
+### `sign-repo-url`
+
+Sign all Maven artifacts in a repository URL through the RADAS signing service. Produces a JSON file containing the signing results.
+
+```bash
+novabucks sign-repo-url \
+  https://example.com/maven/repo \
+  --requester "user@redhat.com" \
+  --result-path ./sign-result.json \
+  --config radas_cfg.json \
+  --sign-key "my-sign-key" \
+  --ignore-patterns ".*\.md5$" \
+  --ignore-patterns ".*\.sha1$"
+```
+
+| Option | Short | Required | Description |
+|--------|-------|----------|-------------|
+| `--requester` | `-r` | Yes | The requester who sends the signing request |
+| `--result-path` | `-p` | Yes | Path to save the sign result JSON file |
+| `--config` | `-c` | Yes | RADAS configuration file path (JSON) |
+| `--sign-key` | `-k` | Yes | rpm-sign key to use |
+| `--ignore-patterns` | `-i` | No | Regex patterns to exclude files from signing (repeatable) |
+| `--debug` | `-D` | No | Enable debug logging |
+| `--quiet` | `-q` | No | Suppress all logs except warnings and errors |
+
+### `generate_sign_files`
+
+Generate `.asc` signature files from the RADAS sign result JSON. Extracts ZIP archives, processes Maven metadata, and copies artifacts with their signatures to a destination directory.
+
+```bash
+novabucks generate_sign_files \
+  https://example.com/archive1.zip \
+  https://example.com/archive2.zip \
+  --product "my-product" \
+  --version "1.0.0" \
+  --root_path "maven-repository" \
+  --destination_dir ./signed-artifacts \
+  --sign_result_file ./sign-result.json \
+  --ignore_patterns ".*\.md5$"
+```
+
+| Option | Short | Required | Default | Description |
+|--------|-------|----------|---------|-------------|
+| `--product` | `-p` | Yes | - | Product key, combined with version for metadata |
+| `--version` | `-v` | Yes | - | Product version, combined with key for metadata |
+| `--root_path` | `-r` | No | `maven-repository` | Root path in the tarball before real Maven paths |
+| `--ignore_patterns` | `-i` | No | - | Regex patterns to exclude files (repeatable) |
+| `--work_dir` | `-w` | No | auto | Temporary directory for archive extraction |
+| `--destination_dir` | `-o` | No | `signed-artifacts` | Output directory for signed files |
+| `--sign_result_file` | `-l` | No | - | Path to the RADAS signing result JSON file |
+| `--debug` | `-D` | No | - | Enable debug logging |
+| `--quiet` | `-q` | No | - | Suppress all logs except warnings and errors |
+
+### RADAS Configuration
+
+Both commands require a RADAS configuration file (`--config` / `--sign_result_file`) for communicating with the signing service over UMB (Unified Message Bus). Example `radas_cfg.json`:
+
+```json
+{
+  "umb_host": "umb.stage.api.redhat.com",
+  "result_queue": "Consumer.<consumer-name>.VirtualTopic.eng.robosignatory.mrrc.sign.>",
+  "request_channel": "topic://VirtualTopic.eng.mrrc-signing-pipeline.mrrc.sign",
+  "client_ca": "/path/to/client.crt",
+  "client_key": "/path/to/client.pem",
+  "client_key_pass_file": "/path/to/client.pw",
+  "root_ca": "/path/to/ca-bundle.crt",
+  "radas_receiver_timeout": 3600
+}
+```
+
+| Field | Description |
+|-------|-------------|
+| `umb_host` | UMB message broker hostname |
+| `result_queue` | AMQP queue for receiving signing results |
+| `request_channel` | AMQP topic for sending signing requests |
+| `client_ca` | Path to the client CA certificate |
+| `client_key` | Path to the client private key |
+| `client_key_pass_file` | Path to file containing the private key passphrase |
+| `root_ca` | Path to the root CA bundle |
+| `radas_receiver_timeout` | Timeout in seconds for waiting on signing results |
+
+## Development
+
+### Running Tests
+
+```bash
+pytest
+```
+
+Or via tox:
+
+```bash
+tox -e py311
+```
+
+### Code Standards
+
+The project enforces the following standards, all configured with a **120-character line length** and targeting **Python 3.11**:
+
+- **Black** -- Code formatter (skip string normalization with `-S`)
+- **Ruff** -- Linter with rules: `E` (pycodestyle errors), `F` (pyflakes), `W` (pycodestyle warnings), `I` (import sorting)
+- **Flake8** -- Additional style checking
+- **Bandit** -- Security vulnerability scanning
+- **pip-audit** -- Dependency vulnerability scanning
+
+### Linting and Formatting
+
+Check formatting (no changes applied):
+
+```bash
+tox -e black
+```
+
+Auto-format code:
+
+```bash
+tox -e black-format
+```
+
+Run ruff:
+
+```bash
+tox -e ruff
+```
+
+Run flake8:
+
+```bash
+tox -e flake8
+```
+
+### Security Checks
+
+```bash
+tox -e bandit
+tox -e pip-audit
+```
+
+### Running All Checks
+
+```bash
+tox
+```
+
+This runs all environments: `py311`, `flake8`, `black`, `ruff`, `bandit`, `pip-audit`.
+
+## License
+
+Apache License 2.0

novabucks-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=78.1.1"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "novabucks"
+version = "0.1.0"
+description = "CLI tool for signing Maven artifacts"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+dependencies = [
+    "click>=8.0",
+    "defusedxml>=0.7.0",
+    "jinja2>=3.0",
+    "oras>=0.1.0",
+    "python-qpid-proton>=0.31.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.4",
+]
+
+[project.scripts]
+novabucks = "novabucks.cli:main"
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]

novabucks-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

novabucks-0.1.0/src/novabucks/__init__.py

@@ -0,0 +1,17 @@
+"""
+Copyright (C) 2022 Red Hat, Inc. (https://github.com/Commonjava/charon)
+
+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.
+"""
+
+__version__ = "0.1.0"

novabucks-0.1.0/src/novabucks/__main__.py

@@ -0,0 +1,19 @@
+"""
+Copyright (C) 2022 Red Hat, Inc. (https://github.com/Commonjava/charon)
+
+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.
+"""
+
+from novabucks.cli import main
+
+main()

novabucks-0.1.0/src/novabucks/cli.py

@@ -0,0 +1,188 @@
+"""
+Copyright (C) 2022 Red Hat, Inc. (https://github.com/Commonjava/charon)
+
+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.
+"""
+
+import logging
+import sys
+import traceback
+from typing import List
+
+import click
+
+from novabucks import __version__
+from novabucks.utils.logs import set_logging
+from novabucks.utils.storage import safe_delete
+from novabucks.workflows import sign_in_radas_workflow, sign_individual_artifacts_workflow
+
+logger = logging.getLogger(__name__)
+
+
+def _log_mode(action_name, is_quiet, is_debug, use_log_file=True):
+    if is_quiet:
+        logger.info("Quiet mode enabled, will only give warning and error logs.")
+        set_logging(action_name, level=logging.WARNING, use_log_file=use_log_file)
+    elif is_debug:
+        logger.info("Debug mode enabled, will give all debug logs for tracing.")
+        set_logging(action_name, level=logging.DEBUG, use_log_file=use_log_file)
+    else:
+        set_logging(action_name, level=logging.INFO, use_log_file=use_log_file)
+
+
+@click.group(invoke_without_command=True)
+@click.version_option(__version__, prog_name="novabucks")
+@click.pass_context
+def main(ctx):
+    """CLI tool for signing Maven artifacts."""
+    if ctx.invoked_subcommand is None:
+        click.echo(ctx.get_help())
+        ctx.exit(2)
+
+
+@main.command()
+@click.argument("repo_url")
+@click.option("--requester", "-r", required=True, help="The requester who sends the signing request.")
+@click.option("--result-path", "-p", required=True, help="The path which will save the sign result file.")
+@click.option("--ignore-patterns", "-i", multiple=True, help="Regex patterns to filter out files from signing.")
+@click.option(
+    "--config", "-c", type=click.File("r"), required=True, help="The radas configuration file path in JSON format."
+)
+@click.option("--sign-key", "-k", required=True, help="rpm-sign key to be used.")
+@click.option("--debug", "-D", is_flag=True, default=False, help="Debug mode.")
+@click.option("--quiet", "-q", is_flag=True, default=False, help="Quiet mode.")
+def sign_repo_url(repo_url, requester, result_path, ignore_patterns, config, sign_key, debug, quiet):
+    """Sign Maven artifacts in the given repo URL through radas service.
+
+    This command will generate a single sign result json file with all the signed artifacts.
+    """
+    _log_mode("repo_signing", is_quiet=quiet, is_debug=debug)
+    logger.debug("%s", ignore_patterns)
+    try:
+        sign_in_radas_workflow(repo_url, requester, sign_key, result_path, ignore_patterns, config)
+    except SystemExit:
+        raise
+    except Exception:
+        print(traceback.format_exc())
+        sys.exit(2)
+
+
+@main.command()
+@click.argument("repos", type=str, nargs=-1)  # This allows multiple arguments for zip urls
+@click.option(
+    "--product",
+    "-p",
+    help="""
+    The product key, will combine with version to decide
+    the metadata of the files in tarball.
+    """,
+    nargs=1,
+    required=True,
+    multiple=False,
+)
+@click.option(
+    "--version",
+    "-v",
+    help="""
+    The product version, will combine with key to decide
+    the metadata of the files in tarball.
+    """,
+    required=True,
+    multiple=False,
+)
+@click.option(
+    "--root_path",
+    "-r",
+    default="maven-repository",
+    help="""
+    The root path in the tarball before the real maven paths,
+    will be trailing off before copying to the destination directory.
+    """,
+)
+@click.option(
+    "--ignore_patterns",
+    "-i",
+    multiple=True,
+    help="""
+    The regex patterns list to filter out the files which should
+    not be allowed to upload to S3. Can accept more than one pattern.
+    """,
+)
+@click.option(
+    "--work_dir",
+    "-w",
+    help="""
+    The temporary working directory into which archives should
+    be extracted, when needed.
+    """,
+)
+@click.option(
+    '--destination_dir',
+    '-o',
+    help="""
+    The destination directory to all the files and alongisde the .asc files to be copied.
+    """,
+    default="signed-artifacts",
+)
+@click.option(
+    "--debug", "-D", help="Debug mode, will print all debug logs for problem tracking.", is_flag=True, default=False
+)
+@click.option(
+    "--quiet",
+    "-q",
+    help="Quiet mode, will shrink most of the logs except warning and errors.",
+    is_flag=True,
+    default=False,
+)
+@click.option(
+    "--sign_result_file",
+    "-l",
+    help="""
+    The path of the file which contains radas signature result.
+    It will use the file to generate the corresponding .asc files which will be
+    copied to the destination directory.
+    """,
+)
+def generate_sign_files(
+    repos: List[str],
+    product: str,
+    version: str,
+    root_path="maven-repository",
+    ignore_patterns: List[str] = None,
+    work_dir: str = None,
+    destination_dir: str = None,
+    debug=False,
+    quiet=False,
+    sign_result_file=None,
+):
+    """Generate .asc files based on the sign result json file."""
+    tmp_dir = work_dir
+    _log_mode("artifacts_signing", is_quiet=quiet, is_debug=debug)
+    logger.debug("%s", ignore_patterns)
+    try:
+        product_key = f"{product}-{version}"
+        sign_individual_artifacts_workflow(
+            repos,
+            product_key,
+            root_path,
+            ignore_patterns,
+            work_dir,
+            destination_dir,
+            sign_result_file,
+        )
+    except Exception:
+        print(traceback.format_exc())
+        sys.exit(2)  # distinguish between exception and bad config or bad state
+    finally:
+        if not debug and tmp_dir:
+            safe_delete(tmp_dir)