SWAMPy

✎ CARVE FLESH

EDITING: mixins.py

"""Useful mixins for Challenge and Resource objects"""
from typing import Any
from typing import Dict

class VersionedLEACMEMixin:
    """This mixin stores the version of Let's Encrypt's endpoint being used."""
    @property
    def le_acme_version(self) -> int:
        """Define the version of ACME protocol to use"""
        return getattr(self, '_le_acme_version', 1)

@le_acme_version.setter
    def le_acme_version(self, version: int) -> None:
        # We need to use object.__setattr__ to not depend on the specific implementation of
        # __setattr__  in current class (eg. jose.TypedJSONObjectWithFields raises AttributeError
        # for any attempt to set an attribute to make objects immutable).
        object.__setattr__(self, '_le_acme_version', version)

def __setattr__(self, key: str, value: Any) -> None:
        if key == 'le_acme_version':
            # Required for @property to operate properly. See comment above.
            object.__setattr__(self, key, value)
        else:
            super().__setattr__(key, value)  # pragma: no cover

class ResourceMixin(VersionedLEACMEMixin):
    """
    This mixin generates a RFC8555 compliant JWS payload
    by removing the `resource` field if needed (eg. ACME v2 protocol).
    """
    def to_partial_json(self) -> Dict[str, Any]:
        """See josepy.JSONDeserializable.to_partial_json()"""
        return _safe_jobj_compliance(super(),
                                     'to_partial_json', 'resource')

def fields_to_partial_json(self) -> Dict[str, Any]:
        """See josepy.JSONObjectWithFields.fields_to_partial_json()"""
        return _safe_jobj_compliance(super(),
                                     'fields_to_partial_json', 'resource')

class TypeMixin(VersionedLEACMEMixin):
    """
    This mixin allows generation of a RFC8555 compliant JWS payload
    by removing the `type` field if needed (eg. ACME v2 protocol).
    """
    def to_partial_json(self) -> Dict[str, Any]:
        """See josepy.JSONDeserializable.to_partial_json()"""
        return _safe_jobj_compliance(super(),
                                     'to_partial_json', 'type')

def _safe_jobj_compliance(instance: Any, jobj_method: str,
                          uncompliant_field: str) -> Dict[str, Any]:
    if hasattr(instance, jobj_method):
        jobj: Dict[str, Any] = getattr(instance, jobj_method)()
        if instance.le_acme_version == 2:
            jobj.pop(uncompliant_field, None)
        return jobj

raise AttributeError('Method {0}() is not implemented.'.format(jobj_method))  # pragma: no cover

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __pycache__/	DIR	—	2024-10-01 13:53
📄 __init__.py	PY	726 B	2021-12-07 22:02	EDIT
📄 challenges.py	PY	21.2 KB	2021-12-07 22:02	EDIT
📄 client.py	PY	52.9 KB	2021-12-07 22:02	EDIT
📄 crypto_util.py	PY	16.3 KB	2022-11-09 23:17	EDIT
📄 errors.py	PY	4.2 KB	2021-12-07 22:02	EDIT
📄 fields.py	PY	1.8 KB	2021-12-07 22:02	EDIT
📄 jws.py	PY	2.3 KB	2021-12-07 22:02	EDIT
📄 magic_typing.py	PY	595 B	2021-12-07 22:02	EDIT
📄 messages.py	PY	24.7 KB	2021-12-07 22:02	EDIT
📄 mixins.py	PY	2.8 KB	2021-12-07 22:02	EDIT
📄 standalone.py	PY	12.8 KB	2021-12-07 22:02	EDIT
📄 util.py	PY	303 B	2021-12-07 22:02	EDIT