Class swarmauri_signing_pdf.pdf_signer.PDFSigner

swarmauri_signing_pdf.pdf_signer.PDFSigner

PDFSigner(key_provider=None)

Bases: SigningBase

High-level PDF signer that leverages the CMS signer for cryptography.

Source code in swarmauri_signing_pdf/pdf_signer.py

def __init__(self, key_provider: Optional[IKeyProvider] = None) -> None:
    self._cms = CMSSigner(key_provider=key_provider)

type class-attribute instance-attribute

type = 'SigningBase'

model_config class-attribute instance-attribute

model_config = ConfigDict(
    extra="allow", arbitrary_types_allowed=True
)

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

default_logger class-attribute

default_logger = None

logger class-attribute instance-attribute

logger = None

name class-attribute instance-attribute

name = None

resource class-attribute instance-attribute

resource = Field(default=CRYPTO.value, frozen=True)

version class-attribute instance-attribute

version = '0.1.0'

set_key_provider

set_key_provider(provider)

Source code in swarmauri_signing_pdf/pdf_signer.py

def set_key_provider(self, provider: IKeyProvider) -> None:
    self._cms.set_key_provider(provider)

supports

supports(key_ref=None)

Source code in swarmauri_signing_pdf/pdf_signer.py

def supports(self, key_ref: Optional[str] = None) -> Mapping[str, Iterable[str]]:
    base_caps = {
        "signs": ("bytes", "digest", "envelope", "stream"),
        "verifies": ("bytes", "digest", "envelope", "stream"),
        "envelopes": ("pdf", "structured-json"),
        "algs": ("SHA256", "SHA384", "SHA512"),
        "canons": ("pdf", "json"),
        "features": ("attached", "visual", "timestamp_optional"),
        "status": ("beta",),
    }
    if key_ref is None:
        return base_caps
    return {**base_caps, "key_refs": (key_ref,)}

sign_bytes async

sign_bytes(key, payload, *, alg=None, opts=None)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def sign_bytes(
    self,
    key: KeyRef,
    payload: bytes,
    *,
    alg: Optional[Alg] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    pdf_opts = dict(opts or {})
    pdf_opts.setdefault("attached", True)
    cms_sigs = await self._cms.sign_bytes(
        key, _ensure_bytes(payload), alg=alg, opts=pdf_opts
    )
    pdf_meta = _pdf_meta(pdf_opts)
    return [
        _adapt_signature(sig, payload_kind="bytes", pdf_meta=pdf_meta)
        for sig in cms_sigs
    ]

sign_digest async

sign_digest(key, digest, *, alg=None, opts=None)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def sign_digest(
    self,
    key: KeyRef,
    digest: bytes,
    *,
    alg: Optional[Alg] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    pdf_opts = dict(opts or {})
    pdf_opts.setdefault("attached", True)
    cms_sigs = await self._cms.sign_digest(key, digest, alg=alg, opts=pdf_opts)
    pdf_meta = _pdf_meta(pdf_opts)
    return [
        _adapt_signature(sig, payload_kind="digest", pdf_meta=pdf_meta)
        for sig in cms_sigs
    ]

sign_stream async

sign_stream(key, payload, *, alg=None, opts=None)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def sign_stream(
    self,
    key: KeyRef,
    payload: StreamLike,
    *,
    alg: Optional[Alg] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    pdf_opts = dict(opts or {})
    pdf_opts.setdefault("attached", True)
    cms_sigs = await self._cms.sign_stream(key, payload, alg=alg, opts=pdf_opts)
    pdf_meta = _pdf_meta(pdf_opts)
    return [
        _adapt_signature(sig, payload_kind="stream", pdf_meta=pdf_meta)
        for sig in cms_sigs
    ]

sign_envelope async

sign_envelope(key, env, *, alg=None, canon=None, opts=None)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def sign_envelope(
    self,
    key: KeyRef,
    env: Envelope,
    *,
    alg: Optional[Alg] = None,
    canon: Optional[Canon] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    canonical = await self.canonicalize_envelope(env, canon=canon, opts=opts)
    pdf_opts = dict(opts or {})
    pdf_opts.setdefault("attached", True)
    cms_sigs = await self._cms.sign_bytes(key, canonical, alg=alg, opts=pdf_opts)
    pdf_meta = _pdf_meta(pdf_opts)
    return [
        _adapt_signature(sig, payload_kind="envelope", pdf_meta=pdf_meta)
        for sig in cms_sigs
    ]

verify_bytes async

verify_bytes(
    payload, signatures, *, require=None, opts=None
)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def verify_bytes(
    self,
    payload: bytes,
    signatures: Sequence[Signature],
    *,
    require: Optional[Mapping[str, object]] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bool:
    return await self._cms.verify_bytes(
        _ensure_bytes(payload), signatures, require=require, opts=opts
    )

verify_digest async

verify_digest(
    digest, signatures, *, require=None, opts=None
)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def verify_digest(
    self,
    digest: bytes,
    signatures: Sequence[Signature],
    *,
    require: Optional[Mapping[str, object]] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bool:
    return await self._cms.verify_digest(
        digest, signatures, require=require, opts=opts
    )

verify_stream async

verify_stream(
    payload, signatures, *, require=None, opts=None
)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def verify_stream(
    self,
    payload: StreamLike,
    signatures: Sequence[Signature],
    *,
    require: Optional[Mapping[str, object]] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bool:
    return await self._cms.verify_stream(
        payload, signatures, require=require, opts=opts
    )

verify_envelope async

verify_envelope(
    env, signatures, *, canon=None, require=None, opts=None
)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def verify_envelope(
    self,
    env: Envelope,
    signatures: Sequence[Signature],
    *,
    canon: Optional[Canon] = None,
    require: Optional[Mapping[str, object]] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bool:
    canonical = await self.canonicalize_envelope(env, canon=canon, opts=opts)
    return await self._cms.verify_envelope(
        canonical,
        signatures,
        canon="raw",
        require=require,
        opts=opts,
    )

canonicalize_envelope async

canonicalize_envelope(env, *, canon=None, opts=None)

Source code in swarmauri_signing_pdf/pdf_signer.py

async def canonicalize_envelope(
    self,
    env: Envelope,
    *,
    canon: Optional[Canon] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bytes:
    if canon in (None, "pdf"):
        if isinstance(env, (bytes, bytearray)):
            return bytes(env)
        raise TypeError("PDF envelopes require bytes payloads")
    if canon == "json":
        if isinstance(env, Mapping):
            return _canon_json(env)
        raise TypeError("json canon expects mapping envelope for PDFSigner")
    raise ValueError(f"Unsupported canon for PDFSigner: {canon}")

register_model classmethod

register_model()

Decorator to register a base model in the unified registry.

RETURNS	DESCRIPTION
Callable	A decorator function that registers the model class. TYPE: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type classmethod

register_type(resource_type=None, type_name=None)

Decorator to register a subtype under one or more base models in the unified registry.

PARAMETER	DESCRIPTION
resource_type	The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. TYPE: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_toml

model_dump_toml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a TOML representation of the model.

Source code in swarmauri_base/TomlMixin.py

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a YAML representation of the model.

Source code in swarmauri_base/YamlMixin.py

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger