Gecko [ 37julay.space ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2024-01-22 04:29
__init__.py	726 B	-rw-r--r--	2021-12-07 22:02
challenges.py	21.19 KB	-rw-r--r--	2021-12-07 22:02
client.py	52.86 KB	-rw-r--r--	2021-12-07 22:02
crypto_util.py	16.34 KB	-rw-r--r--	2022-11-09 23:17
errors.py	4.21 KB	-rw-r--r--	2021-12-07 22:02
fields.py	1.84 KB	-rw-r--r--	2021-12-07 22:02
jws.py	2.33 KB	-rw-r--r--	2021-12-07 22:02
magic_typing.py	595 B	-rw-r--r--	2021-12-07 22:02
messages.py	24.74 KB	-rw-r--r--	2021-12-07 22:02
mixins.py	2.78 KB	-rw-r--r--	2021-12-07 22:02
standalone.py	12.83 KB	-rw-r--r--	2021-12-07 22:02
util.py	303 B	-rw-r--r--	2021-12-07 22:02

Rename

"""ACME-specific JWS.

The JWS implementation in josepy only implements the base JOSE standard. In
order to support the new header fields defined in ACME, this module defines some
ACME-specific classes that layer on top of josepy.
"""
from typing import Optional

import josepy as jose

class Header(jose.Header):
    """ACME-specific JOSE Header. Implements nonce, kid, and url.
    """
    nonce = jose.Field('nonce', omitempty=True, encoder=jose.encode_b64jose)
    kid = jose.Field('kid', omitempty=True)
    url = jose.Field('url', omitempty=True)

# Mypy does not understand the josepy magic happening here, and falsely claims
    # that nonce is redefined. Let's ignore the type check here.
    @nonce.decoder  # type: ignore
    def nonce(value: str) -> bytes:  # pylint: disable=no-self-argument,missing-function-docstring
        try:
            return jose.decode_b64jose(value)
        except jose.DeserializationError as error:
            # TODO: custom error
            raise jose.DeserializationError("Invalid nonce: {0}".format(error))

class Signature(jose.Signature):
    """ACME-specific Signature. Uses ACME-specific Header for customer fields."""
    __slots__ = jose.Signature._orig_slots  # pylint: disable=no-member

# TODO: decoder/encoder should accept cls? Otherwise, subclassing
    # JSONObjectWithFields is tricky...
    header_cls = Header
    header = jose.Field(
        'header', omitempty=True, default=header_cls(),
        decoder=header_cls.from_json)

# TODO: decoder should check that nonce is in the protected header

class JWS(jose.JWS):
    """ACME-specific JWS. Includes none, url, and kid in protected header."""
    signature_cls = Signature
    __slots__ = jose.JWS._orig_slots

@classmethod
    # pylint: disable=arguments-differ
    def sign(cls, payload: bytes, key: jose.JWK, alg: jose.JWASignature, nonce: Optional[bytes],
             url: Optional[str] = None, kid: Optional[str] = None) -> jose.JWS:
        # Per ACME spec, jwk and kid are mutually exclusive, so only include a
        # jwk field if kid is not provided.
        include_jwk = kid is None
        return super().sign(payload, key=key, alg=alg,
                            protect=frozenset(['nonce', 'url', 'kid', 'jwk', 'alg']),
                            nonce=nonce, url=url, kid=kid,
                            include_jwk=include_jwk)