swarmauri_crypto_jwe 0.2.0.dev3__tar.gz → 0.2.0.dev31__tar.gz

{swarmauri_crypto_jwe-0.2.0.dev3 → swarmauri_crypto_jwe-0.2.0.dev31}/PKG-INFO

@@ -1,10 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: swarmauri_crypto_jwe
-Version: 0.2.0.dev3
+Version: 0.2.0.dev31
 Summary: RFC 7516/7518 compliant JWE crypto provider for Swarmauri
-License: Apache-2.0
-Author: Swarmauri
-Author-email: opensource@swarmauri.com
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: swarmauri,sdk,standards,crypto,jwe,cryptography
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
 Requires-Python: >=3.10,<3.13
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
@@ -15,6 +17,9 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Development Status :: 3 - Alpha
 Classifier: Topic :: Security :: Cryptography
 Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Provides-Extra: cbor
 Provides-Extra: json
 Requires-Dist: cbor2 ; extra == "cbor"
@@ -23,7 +28,7 @@ Requires-Dist: swarmauri_base
 Requires-Dist: swarmauri_core
 Description-Content-Type: text/markdown
 
-![Swamauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
+![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
 
 <p align="center">
     <a href="https://pypi.org/project/swarmauri_crypto_jwe/"><img src="https://img.shields.io/pypi/dm/swarmauri_crypto_jwe" alt="PyPI - Downloads"/></a>
@@ -39,16 +44,29 @@ Description-Content-Type: text/markdown
 
 JSON Web Encryption (JWE) provider implementing RFC 7516 and RFC 7518 compliant encryption and decryption helpers.
 
-- Supports `dir`, `RSA-OAEP`, `RSA-OAEP-256`, and `ECDH-ES`
-- Supports `A128GCM`, `A192GCM`, and `A256GCM`
-- Optional compression (`zip` = `DEF`) and Additional Authenticated Data (AAD)
+### Features
+
+- Asynchronous API for compact JWE serialization returning strings.
+- Accepts `JWAAlg` enums from [`swarmauri_core.crypto.types`](https://github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/core/swarmauri_core/crypto/types.py) for algorithms.
+- Supports `dir`, `RSA-OAEP`, `RSA-OAEP-256`, and `ECDH-ES` key management algorithms.
+- Supports `A128GCM`, `A192GCM`, and `A256GCM` content encryption.
+- Optional compression (`zip` = `DEF`) and Additional Authenticated Data (AAD).
+- Returns structured decrypt results that include both the protected header and plaintext.
+- Registers with the Swarmauri PluginManager via the `swarmauri.cryptos` entry point.
 
 ### Installation
 
 ```bash
 pip install swarmauri_crypto_jwe
+# or
+poetry add swarmauri_crypto_jwe
+# or, with uv
+uv add swarmauri_crypto_jwe
 ```
 
+> [!TIP]
+> `uv` can be installed with `pip install uv` or by following the instructions at [astral.sh/uv](https://docs.astral.sh/uv/). Once installed, run `uv add swarmauri_crypto_jwe` from your project directory to add the dependency.
+
 ### Usage
 
 The helpers are asynchronous and return compact JWE strings that can be
@@ -64,6 +82,7 @@ decrypted back into their original plaintext. A typical flow is:
 import asyncio
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
+from swarmauri_core.crypto.types import JWAAlg
 from swarmauri_crypto_jwe import JweCrypto
 
 
@@ -78,8 +97,8 @@ async def main() -> None:
 
     jwe = await crypto.encrypt_compact(
         payload=b"secret",
-        alg="RSA-OAEP-256",
-        enc="A256GCM",
+        alg=JWAAlg.RSA_OAEP_256,
+        enc=JWAAlg.A256GCM,
         key={"pub": pk_pem},
     )
 
@@ -97,16 +116,33 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+### Loading via PluginManager
+
+```python
+from swarmauri.plugin import PluginManager
+
+pm = PluginManager()
+crypto = pm.load("swarmauri.cryptos", "JweCrypto")
+```
+
 **Parameters**
 
-- `alg` – key management algorithm such as `RSA-OAEP-256` or `dir`.
-- `enc` – content encryption algorithm like `A256GCM`.
-- `key` – mapping containing the public key or direct symmetric key
-  material.
-- Decryption requires the matching private key via `rsa_private_pem`,
-  `dir_key`, or `ecdh_private_key`.
+- `alg` – `JWAAlg` member describing the key management algorithm (`JWAAlg.RSA_OAEP_256`, `JWAAlg.DIR`, etc.).
+- `enc` – `JWAAlg` member describing the content encryption algorithm (`JWAAlg.A256GCM`, `JWAAlg.A128GCM`, etc.).
+- `key` – mapping containing the key material used for encryption:
+  - `{"k": bytes}` for direct symmetric keys (`dir`).
+  - `{"pub": rsa_public_key}` for RSA OAEP, where the public key may be PEM bytes or an `RSAPublicKey` instance.
+  - `{"pub": ec_public_key}` for ECDH-ES with PEM, JWK, or key objects.
+- Optional `header_extra` values are merged into the protected header (use `zip="DEF"` to enable compression).
+- Decryption requires the matching private key via `dir_key`, `rsa_private_pem`/`rsa_private_password`, or `ecdh_private_key`.
+- `expected_algs` and `expected_encs` constrain acceptable algorithms during decryption, and `aad` must match the authenticated data provided at encryption time.
 
 ## Entry point
 
 The provider is registered under the `swarmauri.cryptos` entry point as `JweCrypto`.
 
+## Want to help?
+
+If you want to contribute to swarmauri-sdk, read up on our
+[guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/CONTRIBUTING.md)
+that will help you get started.

{swarmauri_crypto_jwe-0.2.0.dev3 → swarmauri_crypto_jwe-0.2.0.dev31}/README.md

@@ -1,4 +1,4 @@
-![Swamauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
+![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
 
 <p align="center">
     <a href="https://pypi.org/project/swarmauri_crypto_jwe/"><img src="https://img.shields.io/pypi/dm/swarmauri_crypto_jwe" alt="PyPI - Downloads"/></a>
@@ -14,16 +14,29 @@
 
 JSON Web Encryption (JWE) provider implementing RFC 7516 and RFC 7518 compliant encryption and decryption helpers.
 
-- Supports `dir`, `RSA-OAEP`, `RSA-OAEP-256`, and `ECDH-ES`
-- Supports `A128GCM`, `A192GCM`, and `A256GCM`
-- Optional compression (`zip` = `DEF`) and Additional Authenticated Data (AAD)
+### Features
+
+- Asynchronous API for compact JWE serialization returning strings.
+- Accepts `JWAAlg` enums from [`swarmauri_core.crypto.types`](https://github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/core/swarmauri_core/crypto/types.py) for algorithms.
+- Supports `dir`, `RSA-OAEP`, `RSA-OAEP-256`, and `ECDH-ES` key management algorithms.
+- Supports `A128GCM`, `A192GCM`, and `A256GCM` content encryption.
+- Optional compression (`zip` = `DEF`) and Additional Authenticated Data (AAD).
+- Returns structured decrypt results that include both the protected header and plaintext.
+- Registers with the Swarmauri PluginManager via the `swarmauri.cryptos` entry point.
 
 ### Installation
 
 ```bash
 pip install swarmauri_crypto_jwe
+# or
+poetry add swarmauri_crypto_jwe
+# or, with uv
+uv add swarmauri_crypto_jwe
 ```
 
+> [!TIP]
+> `uv` can be installed with `pip install uv` or by following the instructions at [astral.sh/uv](https://docs.astral.sh/uv/). Once installed, run `uv add swarmauri_crypto_jwe` from your project directory to add the dependency.
+
 ### Usage
 
 The helpers are asynchronous and return compact JWE strings that can be
@@ -39,6 +52,7 @@ decrypted back into their original plaintext. A typical flow is:
 import asyncio
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
+from swarmauri_core.crypto.types import JWAAlg
 from swarmauri_crypto_jwe import JweCrypto
 
 
@@ -53,8 +67,8 @@ async def main() -> None:
 
     jwe = await crypto.encrypt_compact(
         payload=b"secret",
-        alg="RSA-OAEP-256",
-        enc="A256GCM",
+        alg=JWAAlg.RSA_OAEP_256,
+        enc=JWAAlg.A256GCM,
         key={"pub": pk_pem},
     )
 
@@ -72,15 +86,33 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+### Loading via PluginManager
+
+```python
+from swarmauri.plugin import PluginManager
+
+pm = PluginManager()
+crypto = pm.load("swarmauri.cryptos", "JweCrypto")
+```
+
 **Parameters**
 
-- `alg` – key management algorithm such as `RSA-OAEP-256` or `dir`.
-- `enc` – content encryption algorithm like `A256GCM`.
-- `key` – mapping containing the public key or direct symmetric key
-  material.
-- Decryption requires the matching private key via `rsa_private_pem`,
-  `dir_key`, or `ecdh_private_key`.
+- `alg` – `JWAAlg` member describing the key management algorithm (`JWAAlg.RSA_OAEP_256`, `JWAAlg.DIR`, etc.).
+- `enc` – `JWAAlg` member describing the content encryption algorithm (`JWAAlg.A256GCM`, `JWAAlg.A128GCM`, etc.).
+- `key` – mapping containing the key material used for encryption:
+  - `{"k": bytes}` for direct symmetric keys (`dir`).
+  - `{"pub": rsa_public_key}` for RSA OAEP, where the public key may be PEM bytes or an `RSAPublicKey` instance.
+  - `{"pub": ec_public_key}` for ECDH-ES with PEM, JWK, or key objects.
+- Optional `header_extra` values are merged into the protected header (use `zip="DEF"` to enable compression).
+- Decryption requires the matching private key via `dir_key`, `rsa_private_pem`/`rsa_private_password`, or `ecdh_private_key`.
+- `expected_algs` and `expected_encs` constrain acceptable algorithms during decryption, and `aad` must match the authenticated data provided at encryption time.
 
 ## Entry point
 
 The provider is registered under the `swarmauri.cryptos` entry point as `JweCrypto`.
+
+## Want to help?
+
+If you want to contribute to swarmauri-sdk, read up on our
+[guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/CONTRIBUTING.md)
+that will help you get started.

{swarmauri_crypto_jwe-0.2.0.dev3 → swarmauri_crypto_jwe-0.2.0.dev31}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "swarmauri_crypto_jwe"
-version = "0.2.0.dev3"
+version = "0.2.0.dev31"
 description = "RFC 7516/7518 compliant JWE crypto provider for Swarmauri"
 license = "Apache-2.0"
 readme = "README.md"
 requires-python = ">=3.10,<3.13"
-authors = [{ name = "Swarmauri", email = "opensource@swarmauri.com" }]
+authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
 classifiers = [
     "License :: OSI Approved :: Apache Software License",
     "Natural Language :: English",
@@ -16,12 +16,23 @@ classifiers = [
     "Development Status :: 3 - Alpha",
     "Topic :: Security :: Cryptography",
     "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
 ]
 dependencies = [
     "swarmauri_core",
     "swarmauri_base",
     "cryptography>=41",
 ]
+keywords = [
+    'swarmauri',
+    'sdk',
+    'standards',
+    'crypto',
+    'jwe',
+    'cryptography',
+]
 
 [project.optional-dependencies]
 json = []

{swarmauri_crypto_jwe-0.2.0.dev3 → swarmauri_crypto_jwe-0.2.0.dev31}/swarmauri_crypto_jwe/JweCrypto.py

@@ -1,3 +1,9 @@
+"""High level helpers for JSON Web Encryption.
+
+This module provides compact serialization routines for JWE messages as
+specified by RFC 7516 and RFC 7518.
+"""
+
 from __future__ import annotations
 
 import base64
@@ -189,12 +195,22 @@ JWECompact = str
 
 @dataclass
 class JweDecryptResult:
+    """Return value for :meth:`JweCrypto.decrypt_compact`.
+
+    header (Dict[str, Any]): Parsed JWE header.
+    plaintext (bytes): Decrypted payload bytes.
+    """
+
     header: Dict[str, Any]
     plaintext: bytes
 
 
 class JweCrypto:
-    """Utility class for JSON Web Encryption (RFC 7516, RFC 7518)."""
+    """Utility class for working with JSON Web Encryption.
+
+    The helpers create and parse compact JWE strings. All operations are
+    asynchronous to integrate with async workflows.
+    """
 
     async def encrypt_compact(
         self,
@@ -207,6 +223,19 @@ class JweCrypto:
         header_extra: Optional[Mapping[str, Any]] = None,
         aad: Optional[Union[bytes, str]] = None,
     ) -> JWECompact:
+        """Encrypt a payload into a compact JWE string.
+
+        payload (Union[bytes, str, Mapping[str, Any]]): Data to encrypt. Strings and
+            mappings are encoded as UTF-8 JSON.
+        alg (JWAAlg): Key management algorithm.
+        enc (JWAAlg): Content encryption algorithm.
+        key (Mapping[str, Any]): Key material used for encryption.
+        kid (str): Optional key identifier placed in the protected header.
+        header_extra (Mapping[str, Any]): Additional protected header fields.
+        aad (Union[bytes, str]): Additional authenticated data.
+        RETURNS (JWECompact): Compact JWE representation.
+        """
+
         if isinstance(payload, str):
             pt = payload.encode("utf-8")
         elif isinstance(payload, (bytes, bytearray)):
@@ -318,6 +347,20 @@ class JweCrypto:
         expected_encs: Optional[Iterable[JWAAlg]] = None,
         aad: Optional[Union[bytes, str]] = None,
     ) -> JweDecryptResult:
+        """Decrypt a compact JWE string.
+
+        jwe (JWECompact): Serialized JWE to decode.
+        dir_key (Union[bytes, str]): Symmetric key when ``alg='dir'`` is used.
+        rsa_private_pem (Union[str, bytes]): RSA private key in PEM encoding for
+            RSA-OAEP algorithms.
+        rsa_private_password (Union[str, bytes]): Password for the RSA key.
+        ecdh_private_key (Any): Private key for ECDH-ES.
+        expected_algs (Iterable[JWAAlg]): Allowed algorithm values.
+        expected_encs (Iterable[JWAAlg]): Allowed encryption values.
+        aad (Union[bytes, str]): Additional authenticated data.
+        RETURNS (JweDecryptResult): Header and plaintext of the decrypted token.
+        """
+
         parts = jwe.split(".")
         if len(parts) != 5:
             raise ValueError("Invalid JWE compact: expected 5 dot-separated parts.")