MediaSigner 0.6.2__py3-none-any.whl

MediaSigner/__init__.py

@@ -0,0 +1,7 @@
+"""Swarmauri signing facade plugin that re-exports the :class:`MediaSigner`."""
+
+from __future__ import annotations
+
+from ._signer import MediaSigner
+
+__all__ = ["MediaSigner"]

MediaSigner/_signer.py

@@ -0,0 +1,207 @@
+"""Facade that discovers and dispatches to registered signing plugins."""
+
+from __future__ import annotations
+
+from typing import AsyncIterable, Iterable, Mapping, MutableMapping, Optional, Sequence
+
+from swarmauri_base.ComponentBase import ComponentBase, ResourceTypes
+from swarmauri_base.signing.SigningBase import SigningBase
+from swarmauri_core.crypto.types import Alg, KeyRef
+from swarmauri_core.key_providers.IKeyProvider import IKeyProvider
+from swarmauri_core.signing.types import Signature
+
+StreamPayload = AsyncIterable[bytes] | Iterable[bytes]
+
+try:  # Pragmatic optional imports so plugins self-register when available.
+    import swarmauri_signing_cms  # noqa: F401
+except Exception:  # pragma: no cover - plugin optional
+    pass
+
+try:
+    import swarmauri_signing_jws  # noqa: F401
+except Exception:  # pragma: no cover - plugin optional
+    pass
+
+try:
+    import swarmauri_signing_openpgp  # noqa: F401
+except Exception:  # pragma: no cover - plugin optional
+    pass
+
+try:
+    import swarmauri_signing_pdf  # noqa: F401
+except Exception:  # pragma: no cover - plugin optional
+    pass
+
+try:
+    import swarmauri_signing_xmld  # noqa: F401
+except Exception:  # pragma: no cover - plugin optional
+    pass
+
+
+class MediaSigner(ComponentBase):
+    """High-level async facade that routes signing calls to registered plugins."""
+
+    resource: Optional[str] = ResourceTypes.SIGNING.value
+    type: str = "MediaSigner"
+
+    def __init__(self, key_provider: Optional[IKeyProvider] = None) -> None:
+        super().__init__()
+        self._key_provider = key_provider
+        self._plugins: MutableMapping[str, SigningBase] = {}
+        self._load_plugins()
+
+    # ------------------------------------------------------------------
+    def _load_plugins(self) -> None:
+        registry_entry = self.__class__._registry.get("SigningBase", {})
+        subtypes = registry_entry.get("subtypes", {})
+        for type_name, cls in subtypes.items():
+            if type_name in self._plugins:
+                continue
+            plugin = self._instantiate(cls)
+            if plugin is not None:
+                self._plugins[type_name] = plugin
+
+    def _instantiate(self, cls: type[SigningBase]) -> Optional[SigningBase]:
+        try:
+            plugin = cls(key_provider=self._key_provider)
+        except TypeError:
+            plugin = cls()  # type: ignore[call-arg]
+        if self._key_provider and hasattr(plugin, "set_key_provider"):
+            plugin.set_key_provider(self._key_provider)
+        return plugin
+
+    def _resolve(self, fmt: str) -> SigningBase:
+        try:
+            return self._plugins[fmt]
+        except KeyError as exc:  # pragma: no cover - error path
+            raise ValueError(
+                f"No signing plugin registered for format '{fmt}'"
+            ) from exc
+
+    # ------------------------------------------------------------------
+    async def sign_bytes(
+        self,
+        fmt: str,
+        key: KeyRef,
+        payload: bytes,
+        *,
+        alg: Optional[Alg] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> Sequence[Signature]:
+        return await self._resolve(fmt).sign_bytes(key, payload, alg=alg, opts=opts)
+
+    async def sign_digest(
+        self,
+        fmt: str,
+        key: KeyRef,
+        digest: bytes,
+        *,
+        alg: Optional[Alg] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> Sequence[Signature]:
+        return await self._resolve(fmt).sign_digest(key, digest, alg=alg, opts=opts)
+
+    async def verify_bytes(
+        self,
+        fmt: str,
+        payload: bytes,
+        signatures: Sequence[Signature],
+        *,
+        require: Optional[Mapping[str, object]] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> bool:
+        return await self._resolve(fmt).verify_bytes(
+            payload, signatures, require=require, opts=opts
+        )
+
+    async def verify_digest(
+        self,
+        fmt: str,
+        digest: bytes,
+        signatures: Sequence[Signature],
+        *,
+        require: Optional[Mapping[str, object]] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> bool:
+        return await self._resolve(fmt).verify_digest(
+            digest, signatures, require=require, opts=opts
+        )
+
+    async def canonicalize_envelope(
+        self,
+        fmt: str,
+        env,
+        *,
+        canon: Optional[str] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> bytes:
+        return await self._resolve(fmt).canonicalize_envelope(
+            env, canon=canon, opts=opts
+        )
+
+    async def sign_envelope(
+        self,
+        fmt: str,
+        key: KeyRef,
+        env,
+        *,
+        alg: Optional[Alg] = None,
+        canon: Optional[str] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> Sequence[Signature]:
+        return await self._resolve(fmt).sign_envelope(
+            key, env, alg=alg, canon=canon, opts=opts
+        )
+
+    async def sign_stream(
+        self,
+        fmt: str,
+        key: KeyRef,
+        payload: StreamPayload,
+        *,
+        alg: Optional[Alg] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> Sequence[Signature]:
+        return await self._resolve(fmt).sign_stream(key, payload, alg=alg, opts=opts)
+
+    async def verify_envelope(
+        self,
+        fmt: str,
+        env,
+        signatures: Sequence[Signature],
+        *,
+        canon: Optional[str] = None,
+        require: Optional[Mapping[str, object]] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> bool:
+        return await self._resolve(fmt).verify_envelope(
+            env, signatures, canon=canon, require=require, opts=opts
+        )
+
+    async def verify_stream(
+        self,
+        fmt: str,
+        payload: StreamPayload,
+        signatures: Sequence[Signature],
+        *,
+        require: Optional[Mapping[str, object]] = None,
+        opts: Optional[Mapping[str, object]] = None,
+    ) -> bool:
+        return await self._resolve(fmt).verify_stream(
+            payload, signatures, require=require, opts=opts
+        )
+
+    # ------------------------------------------------------------------
+    def supported_formats(self) -> Iterable[str]:
+        return tuple(self._plugins.keys())
+
+    def supports(
+        self, fmt: str, *, key_ref: Optional[str] = None
+    ) -> Mapping[str, Iterable[str]]:
+        plugin = self._resolve(fmt)
+        if key_ref is not None:
+            try:
+                return plugin.supports(key_ref)  # type: ignore[arg-type]
+            except TypeError:
+                pass
+        return plugin.supports()

MediaSigner/cli.py

@@ -0,0 +1,187 @@
+"""Command line utility for interacting with the MediaSigner facade."""
+
+from __future__ import annotations
+
+import argparse
+import asyncio
+import base64
+import json
+import sys
+from pathlib import Path
+from typing import Any, Mapping, MutableMapping, Sequence
+
+from . import MediaSigner
+from swarmauri_core.signing.types import Signature
+
+BytesLike = bytes | bytearray
+
+
+def _read_bytes(path: str | None) -> bytes:
+    if path is None or path == "-":
+        return sys.stdin.buffer.read()
+    return Path(path).read_bytes()
+
+
+def _write_text(path: str | None, content: str) -> None:
+    if path is None or path == "-":
+        sys.stdout.write(content)
+        if not content.endswith("\n"):
+            sys.stdout.write("\n")
+        return
+    Path(path).write_text(content)
+
+
+def _load_json_file(path: str | None) -> Any:
+    if path is None:
+        return None
+    data = Path(path).read_text()
+    return json.loads(data)
+
+
+def _bytes_field(value: BytesLike) -> dict[str, str]:
+    return {"b64": base64.b64encode(bytes(value)).decode("ascii")}
+
+
+def _signature_to_json(signature: Mapping[str, Any]) -> dict[str, Any]:
+    record: dict[str, Any] = {}
+    for key, value in signature.items():
+        if isinstance(value, (bytes, bytearray)):
+            record[key] = _bytes_field(value)
+        elif (
+            isinstance(value, tuple)
+            and value
+            and isinstance(value[0], (bytes, bytearray))
+        ):
+            record[key] = [_bytes_field(item) for item in value]  # type: ignore[arg-type]
+        else:
+            record[key] = value
+    return record
+
+
+def _signature_from_json(data: Mapping[str, Any]) -> MutableMapping[str, Any]:
+    result: MutableMapping[str, Any] = {}
+    for key, value in data.items():
+        if isinstance(value, Mapping) and "b64" in value:
+            result[key] = base64.b64decode(str(value["b64"]))
+        elif (
+            isinstance(value, list)
+            and value
+            and isinstance(value[0], Mapping)
+            and "b64" in value[0]
+        ):
+            result[key] = tuple(base64.b64decode(str(entry["b64"])) for entry in value)
+        else:
+            result[key] = value
+    return result
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        description="Interact with Swarmauri signing plugins"
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    list_parser = subparsers.add_parser("list", help="List discovered signing formats")
+    list_parser.set_defaults(func=_cmd_list)
+
+    supports_parser = subparsers.add_parser(
+        "supports", help="Describe plugin capabilities"
+    )
+    supports_parser.add_argument("format", help="Format token, e.g. jws or cms")
+    supports_parser.add_argument(
+        "--key-ref", dest="key_ref", help="Optional key reference string"
+    )
+    supports_parser.set_defaults(func=_cmd_supports)
+
+    sign_parser = subparsers.add_parser(
+        "sign-bytes", help="Sign raw bytes using a plugin"
+    )
+    sign_parser.add_argument("format", help="Format token")
+    sign_parser.add_argument("--alg", dest="alg", help="Algorithm hint for the signer")
+    sign_parser.add_argument(
+        "--key", required=True, help="Path to a JSON file describing the KeyRef"
+    )
+    sign_parser.add_argument("--input", required=True, help="Payload file to sign")
+    sign_parser.add_argument(
+        "--output", help="Write signatures to this file (defaults to stdout)"
+    )
+    sign_parser.add_argument("--opts", help="Path to JSON options passed to the signer")
+    sign_parser.set_defaults(func=_cmd_sign_bytes)
+
+    verify_parser = subparsers.add_parser(
+        "verify-bytes", help="Verify signatures over raw bytes"
+    )
+    verify_parser.add_argument("format", help="Format token")
+    verify_parser.add_argument("--input", required=True, help="Payload file")
+    verify_parser.add_argument(
+        "--sigs", required=True, help="JSON file produced by sign-bytes"
+    )
+    verify_parser.add_argument(
+        "--opts", help="JSON file providing verification options"
+    )
+    verify_parser.add_argument(
+        "--require", help="JSON file describing verification policy"
+    )
+    verify_parser.set_defaults(func=_cmd_verify_bytes)
+
+    return parser
+
+
+async def _cmd_list(args: argparse.Namespace) -> int:
+    signer = MediaSigner()
+    for fmt in sorted(signer.supported_formats()):
+        print(fmt)
+    return 0
+
+
+async def _cmd_supports(args: argparse.Namespace) -> int:
+    signer = MediaSigner()
+    info = signer.supports(args.format, key_ref=args.key_ref)
+    print(json.dumps(info, indent=2, sort_keys=True))
+    return 0
+
+
+async def _cmd_sign_bytes(args: argparse.Namespace) -> int:
+    signer = MediaSigner()
+    key_data = _load_json_file(args.key)
+    if not isinstance(key_data, Mapping):
+        raise SystemExit("--key must reference a JSON object")
+    payload = _read_bytes(args.input)
+    opts = _load_json_file(args.opts)
+    signatures = await signer.sign_bytes(
+        args.format, key_data, payload, alg=args.alg, opts=opts
+    )
+    json_out = [_signature_to_json(dict(sig)) for sig in signatures]
+    _write_text(args.output, json.dumps(json_out, indent=2))
+    return 0
+
+
+async def _cmd_verify_bytes(args: argparse.Namespace) -> int:
+    signer = MediaSigner()
+    payload = _read_bytes(args.input)
+    sig_payload = _load_json_file(args.sigs)
+    if not isinstance(sig_payload, list):
+        raise SystemExit("--sigs must point to a JSON array")
+    signature_payloads = [_signature_from_json(entry) for entry in sig_payload]
+    signature_entries = [Signature(**dict(entry)) for entry in signature_payloads]
+    opts = _load_json_file(args.opts)
+    require = _load_json_file(args.require)
+    ok = await signer.verify_bytes(
+        args.format,
+        payload,
+        signature_entries,
+        require=require,
+        opts=opts,
+    )
+    print("true" if ok else "false")
+    return 0 if ok else 1
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    parser = _build_parser()
+    args = parser.parse_args(argv)
+    return asyncio.run(args.func(args))
+
+
+if __name__ == "__main__":  # pragma: no cover
+    raise SystemExit(main())

mediasigner-0.6.2.dist-info/METADATA

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: MediaSigner
+Version: 0.6.2
+Summary: Swarmauri signing facade plugin that aggregates registered SigningBase providers.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: swarmauri,digital-signatures,media,cryptography,plugin,orchestration,asyncio,signature-aggregation,workflow-automation,key-management,verification,digital-asset-security,media-compliance,cms,pkcs7,cades,jws,openpgp,pdf-signatures,xmldsig
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: AsyncIO
+Classifier: Topic :: Security :: Cryptography
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Software Development :: Libraries
+Provides-Extra: plugins
+Requires-Dist: cryptography (>=42.0.0)
+Requires-Dist: swarmauri_base
+Requires-Dist: swarmauri_core
+Requires-Dist: swarmauri_keyprovider_inmemory
+Requires-Dist: swarmauri_signing_cms
+Requires-Dist: swarmauri_signing_cms ; extra == "plugins"
+Requires-Dist: swarmauri_signing_jws
+Requires-Dist: swarmauri_signing_jws ; extra == "plugins"
+Requires-Dist: swarmauri_signing_openpgp
+Requires-Dist: swarmauri_signing_openpgp ; extra == "plugins"
+Requires-Dist: swarmauri_signing_pdf
+Requires-Dist: swarmauri_signing_pdf ; extra == "plugins"
+Requires-Dist: swarmauri_signing_xmld
+Requires-Dist: swarmauri_signing_xmld ; extra == "plugins"
+Project-URL: Changelog, https://github.com/swarmauri/swarmauri-sdk/releases
+Project-URL: Documentation, https://github.com/swarmauri/swarmauri-sdk/tree/main/pkgs/plugins/media_signer#readme
+Project-URL: Discussions, https://github.com/orgs/swarmauri/discussions
+Project-URL: Homepage, https://github.com/swarmauri/swarmauri-sdk
+Project-URL: Issues, https://github.com/swarmauri/swarmauri-sdk/issues
+Project-URL: Source, https://github.com/swarmauri/swarmauri-sdk/tree/main/pkgs/plugins/media_signer
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="../../../assets/swarmauri.brand.theme.svg" alt="Swarmauri logotype" width="420" />
+</p>
+
+<h1 align="center">MediaSigner</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/MediaSigner/"><img src="https://img.shields.io/pypi/dm/MediaSigner?style=for-the-badge" alt="PyPI - Downloads" /></a>
+  <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/main/pkgs/plugins/media_signer/"><img src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/main/pkgs/plugins/media_signer.svg?style=for-the-badge" alt="Repository views" /></a>
+  <a href="https://pypi.org/project/MediaSigner/"><img src="https://img.shields.io/pypi/pyversions/MediaSigner?style=for-the-badge" alt="Supported Python versions" /></a>
+  <a href="https://pypi.org/project/MediaSigner/"><img src="https://img.shields.io/pypi/l/MediaSigner?style=for-the-badge" alt="License" /></a>
+  <a href="https://pypi.org/project/MediaSigner/"><img src="https://img.shields.io/pypi/v/MediaSigner?style=for-the-badge&label=MediaSigner" alt="Latest release" /></a>
+</p>
+
+---
+
+MediaSigner packages the asynchronous `Signer` facade that orchestrates registered
+`SigningBase` providers. Moving the facade into a standalone plugin keeps the
+core standards library lightweight while still enabling drop-in discovery of
+specialised signers such as CMS, JWS, OpenPGP, PDF, and XMLDSig providers.
+
+## Features
+
+- **Unified signing façade** – talk to every installed `SigningBase` through a
+  single async API that automatically discovers entry-point contributions.
+- **Format-aware routing** – delegates signing and verification to the provider
+  registered for a format token such as `jws`, `pdf`, or `xmld`.
+- **Optional plugin bundles** – install curated extras (e.g. `[plugins]`) to
+  bring in all available signer backends in one step.
+- **Key-provider integration** – share Swarmauri key providers with the facade
+  so opaque key references resolve before signature creation.
+- **Production-ready CLI** – inspect capabilities, sign payloads, and verify
+  results directly from the command line for fast automation.
+
+## Installation
+
+### Using `uv`
+
+```bash
+uv add MediaSigner
+
+# install every optional backend
+uv add "MediaSigner[plugins]"
+```
+
+The `[plugins]` extra pulls in CMS, JWS, OpenPGP, PDF, and XMLDSig signers.
+
+### Using `pip`
+
+```bash
+pip install MediaSigner
+
+# with every optional backend
+pip install "MediaSigner[plugins]"
+```
+
+## Usage
+
+```python
+import asyncio
+
+from MediaSigner import MediaSigner
+from swarmauri_core.key_providers.IKeyProvider import IKeyProvider
+
+# Optionally pass a key provider so plugins receive a shared source for
+# retrieving signing material.
+key_provider: IKeyProvider | None = None
+signer = MediaSigner(key_provider=key_provider)
+
+
+async def sign_payload(payload: bytes) -> None:
+    signatures = await signer.sign_bytes("jws", key="my-key", payload=payload)
+    assert signatures, "At least one signature should be returned"
+    print(signer.supports("jws"))
+
+
+asyncio.run(sign_payload(b"payload"))
+```
+
+### Integrating a key provider
+
+Any Swarmauri key provider can be shared with the facade so backends receive
+ready-to-use key material:
+
+```python
+import asyncio
+
+from MediaSigner import MediaSigner
+from swarmauri_keyprovider_inmemory import InMemoryKeyProvider
+
+provider = InMemoryKeyProvider(keys={"local://demo": b"secret"})
+signer = MediaSigner(key_provider=provider)
+
+
+async def main() -> None:
+    signatures = await signer.sign_bytes(
+        "jws",
+        key="local://demo",
+        payload=b"demo",
+        alg="HS256",
+        opts={"kid": "demo"},
+    )
+    print(signatures[0].mode)
+
+
+asyncio.run(main())
+```
+
+### Discover installed plugins
+
+Use the facade to list installed signers and inspect their capabilities:
+
+```python
+for format_name in signer.supported_formats():
+    capabilities = signer.supports(format_name)
+    print(format_name, list(capabilities))
+```
+
+### Why this structure?
+
+* **Separation of concerns** – standards remain focused on common abstractions
+  while the plugin encapsulates optional dependencies.
+* **Explicit opt-in** – downstream projects can install only the signing stacks
+  they need via the curated extras.
+* **Consistent ergonomics** – usage matches the historical
+  `swarmauri_standard.signing.Signer` import, preserving existing tutorials and
+  code samples.
+
+## Command line utility
+
+MediaSigner ships a small CLI for quick inspection and automation:
+
+```bash
+media-signer list                 # List available formats
+media-signer supports jws         # Show capability metadata
+media-signer sign-bytes jws \
+  --alg HS256 \
+  --key key.json \
+  --input payload.bin \
+  --output signatures.json
+
+media-signer verify-bytes jws \
+  --input payload.bin \
+  --sigs signatures.json \
+  --opts verify-keys.json
+```
+
+The CLI expects JSON files describing `KeyRef` objects and verification
+materials matching the selected plugin.
+
+## Project Resources
+
+- Source: <https://github.com/swarmauri/swarmauri-sdk/tree/main/pkgs/plugins/media_signer>
+- Documentation: <https://github.com/swarmauri/swarmauri-sdk/tree/main/pkgs/plugins/media_signer#readme>
+- Issues: <https://github.com/swarmauri/swarmauri-sdk/issues>
+- Releases: <https://github.com/swarmauri/swarmauri-sdk/releases>
+- Discussions: <https://github.com/orgs/swarmauri/discussions>
+

mediasigner-0.6.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+MediaSigner/__init__.py,sha256=8p0PasgvbJZijXSAu-ByNpvXwoEe9dlidbqPS8kPA8Q,177
+MediaSigner/_signer.py,sha256=cEDL-j91m6H52nM9-0alBD-nJgR4cpYZYUeL3vO3fis,6658
+MediaSigner/cli.py,sha256=Jj4LUWkwXSEev1DghkNgYqKsSONmPIUUr0Iwfg-YWHQ,6184
+mediasigner-0.6.2.dist-info/METADATA,sha256=BM1AsoddRFJp6iWOq6DpM5TVWXAzLBHOP2oYnX8iQ_A,7841
+mediasigner-0.6.2.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
+mediasigner-0.6.2.dist-info/entry_points.txt,sha256=pk-u4om8it63TW_cXFxFOXlOKe6z4U2VSdda68rCsdg,53
+mediasigner-0.6.2.dist-info/licenses/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
+mediasigner-0.6.2.dist-info/RECORD,,

mediasigner-0.6.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.0
+Root-Is-Purelib: true
+Tag: py3-none-any

mediasigner-0.6.2.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+media-signer=MediaSigner.cli:main
+

mediasigner-0.6.2.dist-info/licenses/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 [2025] [Jacob Stewart @ Swarmauri]
+
+   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.