Skip to content

Class swarmauri_signing_ca.CASigner.CASigner

swarmauri_signing_ca.CASigner.CASigner

Bases: SigningBase

CA-capable detached signer.

type class-attribute instance-attribute

type = 'CASigner'

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'

supports

supports()
Source code in swarmauri_signing_ca/CASigner.py
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def supports(self) -> Mapping[str, Iterable[str]]:
    envelopes = ("detached-bytes", "x509-csr", "structured-json")
    return {
        "signs": ("bytes", "digest", "envelope", "stream"),
        "verifies": ("bytes", "digest", "envelope", "stream"),
        "envelopes": ("mapping", *envelopes),
        "algs": (
            "Ed25519",
            "ECDSA-P256-SHA256",
            "RSA-PSS-SHA256",
            "PS256",
            "RS256",
        ),
        "canons": ("json",),
        "features": ("multi", "detached_only", "x509"),
    }

sign_bytes async

sign_bytes(key, payload, *, alg=None, opts=None)
Source code in swarmauri_signing_ca/CASigner.py
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
async def sign_bytes(
    self,
    key: KeyRef,
    payload: bytes,
    *,
    alg: Optional[Alg] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    priv = _load_private_from_keyref(key)
    sig = _sign_bytes_with(priv, payload, str(alg) if alg is not None else None)
    kid = _key_id_from_public(_public_of(priv))
    return [
        _Sig(
            {
                "alg": str(alg) if alg else _alg_from_key(priv),
                "kid": kid,
                "sig": sig,
                "created_at": int(dt.datetime.utcnow().timestamp()),
            }
        )
    ]

verify_bytes async

verify_bytes(
    payload, signatures, *, require=None, opts=None
)
Source code in swarmauri_signing_ca/CASigner.py
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
async def verify_bytes(
    self,
    payload: bytes,
    signatures: Sequence[Signature],
    *,
    require: Optional[Mapping[str, object]] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bool:
    pubs: list[
        Union[ed25519.Ed25519PublicKey, ec.EllipticCurvePublicKey, rsa.RSAPublicKey]
    ] = []
    if opts and "pubkeys" in opts:
        for item in opts["pubkeys"]:  # type: ignore[index]
            if isinstance(
                item,
                (
                    ed25519.Ed25519PublicKey,
                    ec.EllipticCurvePublicKey,
                    rsa.RSAPublicKey,
                ),
            ):
                pubs.append(item)
            elif isinstance(item, (bytes, bytearray)):
                pk = serialization.load_pem_public_key(bytes(item))
                pubs.append(pk)  # type: ignore[arg-type]
            else:
                raise TypeError(
                    "CASigner.verify_bytes: unsupported public key entry in opts['pubkeys']."
                )

    min_signers = int(require.get("min_signers", 1)) if require else 1

    accepted = 0
    for sig in signatures:
        alg = sig.get("alg") if isinstance(sig, Mapping) else None
        sig_bytes = sig.get("sig") if isinstance(sig, Mapping) else None
        if not isinstance(sig_bytes, (bytes, bytearray)):
            continue
        ok_one = False
        for pk in pubs:
            if _verify_bytes_with(
                pk, payload, bytes(sig_bytes), str(alg) if alg is not None else None
            ):
                ok_one = True
                break
        if ok_one:
            accepted += 1
        if accepted >= min_signers:
            return True
    return False

sign_digest async

sign_digest(key, digest, *, alg=None, opts=None)
Source code in swarmauri_signing_ca/CASigner.py
331
332
333
334
335
336
337
338
339
async def sign_digest(
    self,
    key: KeyRef,
    digest: bytes,
    *,
    alg: Optional[Alg] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    return await self.sign_bytes(key, digest, alg=alg, opts=opts)

verify_digest async

verify_digest(
    digest, signatures, *, require=None, opts=None
)
Source code in swarmauri_signing_ca/CASigner.py
341
342
343
344
345
346
347
348
349
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.verify_bytes(digest, signatures, require=require, opts=opts)

canonicalize_envelope async

canonicalize_envelope(env, *, canon=None, opts=None)
Source code in swarmauri_signing_ca/CASigner.py
351
352
353
354
355
356
357
358
359
360
async def canonicalize_envelope(
    self,
    env: Envelope,
    *,
    canon: Optional[Canon] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bytes:
    if canon in (None, "json"):
        return _canon_json_like(env)
    raise ValueError(f"Unsupported canon: {canon}")

sign_envelope async

sign_envelope(key, env, *, alg=None, canon=None, opts=None)
Source code in swarmauri_signing_ca/CASigner.py
362
363
364
365
366
367
368
369
370
371
372
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]:
    payload = await self.canonicalize_envelope(env, canon=canon, opts=opts)
    return await self.sign_bytes(key, payload, alg=alg, opts=opts)

verify_envelope async

verify_envelope(
    env, signatures, *, canon=None, require=None, opts=None
)
Source code in swarmauri_signing_ca/CASigner.py
374
375
376
377
378
379
380
381
382
383
384
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:
    payload = await self.canonicalize_envelope(env, canon=canon, opts=opts)
    return await self.verify_bytes(payload, signatures, require=require, opts=opts)

issue_self_signed

issue_self_signed(
    ca_key,
    subject,
    *,
    days=3650,
    is_ca=True,
    pathlen=None,
    eku=None,
    san_dns=None,
    serial_number=None,
)
Source code in swarmauri_signing_ca/CASigner.py
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
def issue_self_signed(
    self,
    ca_key: KeyRef,
    subject: Mapping[str, str],
    *,
    days: int = 3650,
    is_ca: bool = True,
    pathlen: Optional[int] = None,
    eku: Optional[Sequence[x509.ExtendedKeyUsage]] = None,
    san_dns: Optional[Sequence[str]] = None,
    serial_number: Optional[int] = None,
) -> bytes:
    priv = _load_private_from_keyref(ca_key)
    pub = _public_of(priv)
    name = _name_from_dict(subject)

    now = dt.datetime.utcnow()
    builder = (
        x509.CertificateBuilder()
        .subject_name(name)
        .issuer_name(name)
        .public_key(pub)
        .serial_number(serial_number or x509.random_serial_number())
        .not_valid_before(now - dt.timedelta(minutes=5))
        .not_valid_after(now + dt.timedelta(days=days))
    )

    builder = (
        builder.add_extension(
            x509.BasicConstraints(ca=is_ca, path_length=pathlen), critical=True
        )
        .add_extension(
            x509.SubjectKeyIdentifier.from_public_key(pub), critical=False
        )
        .add_extension(
            x509.AuthorityKeyIdentifier.from_issuer_public_key(pub), critical=False
        )
        .add_extension(
            x509.KeyUsage(
                digital_signature=True,
                content_commitment=False,
                key_encipherment=False,
                data_encipherment=False,
                key_agreement=False,
                key_cert_sign=True if is_ca else False,
                crl_sign=True if is_ca else False,
                encipher_only=False,
                decipher_only=False,
            ),
            critical=True,
        )
    )

    if eku:
        builder = builder.add_extension(x509.ExtendedKeyUsage(eku), critical=False)

    if san_dns:
        builder = builder.add_extension(
            x509.SubjectAlternativeName([x509.DNSName(d) for d in san_dns]),
            critical=False,
        )

    if isinstance(priv, ed25519.Ed25519PrivateKey):
        cert = builder.sign(private_key=priv, algorithm=None)
    elif isinstance(priv, ec.EllipticCurvePrivateKey):
        cert = builder.sign(private_key=priv, algorithm=hashes.SHA256())
    elif isinstance(priv, rsa.RSAPrivateKey):
        cert = builder.sign(private_key=priv, algorithm=hashes.SHA256())
    else:
        raise ValueError("Unsupported key type for self-signed certificate")

    return cert.public_bytes(Encoding.PEM)

create_csr

create_csr(
    subject,
    key,
    *,
    san_dns=None,
    is_ca=False,
    eku_server_client=True,
)
Source code in swarmauri_signing_ca/CASigner.py
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
def create_csr(
    self,
    subject: Mapping[str, str],
    key: KeyRef,
    *,
    san_dns: Optional[Sequence[str]] = None,
    is_ca: bool = False,
    eku_server_client: bool = True,
) -> bytes:
    priv = _load_private_from_keyref(key)
    name = _name_from_dict(subject)

    csr_builder = x509.CertificateSigningRequestBuilder().subject_name(name)

    san_list = []
    if san_dns:
        san_list.extend(x509.DNSName(d) for d in san_dns)
    if san_list:
        csr_builder = csr_builder.add_extension(
            x509.SubjectAlternativeName(san_list), critical=False
        )

    if is_ca:
        csr_builder = csr_builder.add_extension(
            x509.BasicConstraints(ca=True, path_length=None), critical=True
        )

    if eku_server_client:
        csr_builder = csr_builder.add_extension(
            x509.ExtendedKeyUsage(
                [ExtendedKeyUsageOID.SERVER_AUTH, ExtendedKeyUsageOID.CLIENT_AUTH]
            ),
            critical=False,
        )

    if isinstance(priv, ed25519.Ed25519PrivateKey):
        csr = csr_builder.sign(priv, algorithm=None)
    elif isinstance(priv, ec.EllipticCurvePrivateKey):
        csr = csr_builder.sign(priv, hashes.SHA256())
    elif isinstance(priv, rsa.RSAPrivateKey):
        csr = csr_builder.sign(priv, hashes.SHA256())
    else:
        raise ValueError("Unsupported key type for CSR")

    return csr.public_bytes(Encoding.PEM)

sign_csr

sign_csr(
    csr_pem,
    ca_key,
    ca_cert_pem,
    *,
    days=825,
    is_ca=False,
    pathlen=None,
    ocsp_url=None,
    crl_url=None,
    serial_number=None,
)
Source code in swarmauri_signing_ca/CASigner.py
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
def sign_csr(
    self,
    csr_pem: bytes,
    ca_key: KeyRef,
    ca_cert_pem: bytes,
    *,
    days: int = 825,
    is_ca: bool = False,
    pathlen: Optional[int] = None,
    ocsp_url: Optional[str] = None,
    crl_url: Optional[str] = None,
    serial_number: Optional[int] = None,
) -> bytes:
    csr = x509.load_pem_x509_csr(csr_pem)
    if not csr.is_signature_valid:
        raise ValueError("Invalid CSR signature")

    ca_priv = _load_private_from_keyref(ca_key)
    ca_cert = x509.load_pem_x509_certificate(ca_cert_pem)
    now = dt.datetime.utcnow()

    builder = (
        x509.CertificateBuilder()
        .subject_name(csr.subject)
        .issuer_name(ca_cert.subject)
        .public_key(csr.public_key())
        .serial_number(serial_number or x509.random_serial_number())
        .not_valid_before(now - dt.timedelta(minutes=5))
        .not_valid_after(now + dt.timedelta(days=days))
    )

    for ext in csr.extensions:
        builder = builder.add_extension(ext.value, ext.critical)

    builder = builder.add_extension(
        x509.BasicConstraints(ca=is_ca, path_length=pathlen), critical=True
    )

    builder = builder.add_extension(
        x509.SubjectKeyIdentifier.from_public_key(csr.public_key()), critical=False
    ).add_extension(
        x509.AuthorityKeyIdentifier.from_issuer_public_key(ca_cert.public_key()),
        critical=False,
    )

    builder = builder.add_extension(
        x509.KeyUsage(
            digital_signature=True,
            content_commitment=False,
            key_encipherment=not is_ca,
            data_encipherment=False,
            key_agreement=not is_ca,
            key_cert_sign=is_ca,
            crl_sign=is_ca,
            encipher_only=False,
            decipher_only=False,
        ),
        critical=True,
    )

    if ocsp_url:
        builder = builder.add_extension(
            x509.AuthorityInformationAccess(
                [
                    x509.AccessDescription(
                        x509.AuthorityInformationAccessOID.OCSP,
                        x509.UniformResourceIdentifier(ocsp_url),
                    )
                ]
            ),
            critical=False,
        )
    if crl_url:
        builder = builder.add_extension(
            x509.CRLDistributionPoints(
                [
                    x509.DistributionPoint(
                        full_name=[x509.UniformResourceIdentifier(crl_url)],
                        relative_name=None,
                        reasons=None,
                        crl_issuer=None,
                    )
                ]
            ),
            critical=False,
        )

    if isinstance(ca_priv, ed25519.Ed25519PrivateKey):
        cert = builder.sign(private_key=ca_priv, algorithm=None)
    elif isinstance(ca_priv, ec.EllipticCurvePrivateKey):
        cert = builder.sign(private_key=ca_priv, algorithm=hashes.SHA256())
    elif isinstance(ca_priv, rsa.RSAPrivateKey):
        cert = builder.sign(private_key=ca_priv, algorithm=hashes.SHA256())
    else:
        raise ValueError("Unsupported CA key type")

    return cert.public_bytes(Encoding.PEM)

verify_chain

verify_chain(
    leaf_pem,
    chain_pems=(),
    roots_pems=(),
    *,
    at_time=None,
    require_ca=False,
)
Source code in swarmauri_signing_ca/CASigner.py
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
def verify_chain(
    self,
    leaf_pem: bytes,
    chain_pems: Sequence[bytes] = (),
    roots_pems: Sequence[bytes] = (),
    *,
    at_time: Optional[dt.datetime] = None,
    require_ca: bool = False,
) -> bool:
    at = at_time or dt.datetime.utcnow()

    def load_all(pems: Sequence[bytes]) -> list[x509.Certificate]:
        return [x509.load_pem_x509_certificate(p) for p in pems]

    leaf = x509.load_pem_x509_certificate(leaf_pem)
    chain = load_all(chain_pems)
    roots = load_all(roots_pems)

    def valid_at(cert: x509.Certificate) -> bool:
        return cert.not_valid_before <= at <= cert.not_valid_after

    if not valid_at(leaf):
        return False
    for c in chain:
        if not valid_at(c):
            return False
    for r in roots:
        if not valid_at(r):
            return False

    path = [leaf] + list(chain)

    def verify_sig(child: x509.Certificate, issuer: x509.Certificate) -> bool:
        pub = issuer.public_key()
        try:
            if isinstance(pub, rsa.RSAPublicKey):
                pub.verify(
                    child.signature,
                    child.tbs_certificate_bytes,
                    padding.PKCS1v15(),
                    child.signature_hash_algorithm,
                )
            elif isinstance(pub, ec.EllipticCurvePublicKey):
                pub.verify(
                    child.signature,
                    child.tbs_certificate_bytes,
                    ec.ECDSA(child.signature_hash_algorithm),
                )
            elif isinstance(pub, ed25519.Ed25519PublicKey):
                pub.verify(child.signature, child.tbs_certificate_bytes)
            else:
                return False
            return True
        except Exception:
            return False
        except Exception:
            return False

    issuer_matched_root = None
    for idx in range(len(path)):
        child = path[idx]
        issuer = None
        if idx + 1 < len(path):
            issuer = path[idx + 1]
            if child.issuer != issuer.subject or not verify_sig(child, issuer):
                return False
        else:
            for r in roots:
                if child.issuer == r.subject and verify_sig(child, r):
                    issuer = r
                    issuer_matched_root = r
                    break
            if issuer is None:
                return False

    if require_ca and issuer_matched_root:
        try:
            bc = issuer_matched_root.extensions.get_extension_for_class(
                x509.BasicConstraints
            ).value
            if not bc.ca:
                return False
        except Exception:
            return False

    return True

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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
@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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
@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
12
13
14
15
16
17
18
19
20
21
22
23
24
@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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
11
12
13
14
15
16
17
18
19
20
21
22
23
@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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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
23
24
25
26
27
28
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

sign_stream async

sign_stream(key, payload, *, alg=None, opts=None)
Source code in swarmauri_base/signing/SigningBase.py
116
117
118
119
120
121
122
123
124
125
async def sign_stream(
    self,
    key: KeyRef,
    payload: ByteStream,
    *,
    alg: Optional[Alg] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> Sequence[Signature]:
    data = await _stream_to_bytes(payload)
    return await self.sign_bytes(key, data, alg=alg, opts=opts)

verify_stream async

verify_stream(
    payload, signatures, *, require=None, opts=None
)
Source code in swarmauri_base/signing/SigningBase.py
128
129
130
131
132
133
134
135
136
137
async def verify_stream(
    self,
    payload: ByteStream,
    signatures: Sequence[Signature],
    *,
    require: Optional[Mapping[str, object]] = None,
    opts: Optional[Mapping[str, object]] = None,
) -> bool:
    data = await _stream_to_bytes(payload)
    return await self.verify_bytes(data, signatures, require=require, opts=opts)