chik-base 0.1.7__py3-none-any.whl

chik_base/atoms/__init__.py

@@ -0,0 +1,27 @@
+"""
+This module defines some useful atomic types for building more complex
+data structures.
+
+Except for `hexbytes` (which is just a hex-printing subclass of `bytes`,
+these types are all fixed-sized, simplifying serializing and parsing, like
+those used in `cbincode` (the slight modification to the `bincode` standard that
+chik uses).
+"""
+
+from .hexbytes import hexbytes
+from .ints import int8, uint8, int16, uint16, int32, uint32, int64, uint64
+from .sized_bytes import bytes32
+
+
+__all__ = [
+    "int8",
+    "int16",
+    "int32",
+    "int64",
+    "uint8",
+    "uint16",
+    "uint32",
+    "uint64",
+    "hexbytes",
+    "bytes32",
+]

chik_base/atoms/hexbytes.py

@@ -0,0 +1,11 @@
+class hexbytes(bytes):
+    """
+    This is a subclass of bytes that prints itself out as hex,
+    which is much easier on the eyes for binary data that is very non-ascii .
+    """
+
+    def __str__(self):
+        return self.hex()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, str(self))

chik_base/atoms/ints.py

@@ -0,0 +1,59 @@
+"""
+Some ints of fixed size. Their fixed size makes them easier to parse and serialize.
+
+Each implements these two class methods:
+
+*  `.parse(f: BinaryIO)`
+*  `._class_stream(obj, f: BinaryIO)`
+
+"""
+
+from .struct_stream import struct_stream
+
+
+class int8(int, struct_stream):
+    "signed 8-bit int"
+
+    PACK = "!b"
+
+
+class uint8(int, struct_stream):
+    "unsigned 8-bit int"
+
+    PACK = "!B"
+
+
+class int16(int, struct_stream):
+    "signed 16-bit int"
+
+    PACK = "!h"
+
+
+class uint16(int, struct_stream):
+    "unsigned 16-bit int"
+
+    PACK = "!H"
+
+
+class int32(int, struct_stream):
+    "signed 32-bit int"
+
+    PACK = "!l"
+
+
+class uint32(int, struct_stream):
+    "unsigned 32-bit int"
+
+    PACK = "!L"
+
+
+class int64(int, struct_stream):
+    "signed 64-bit int"
+
+    PACK = "!q"
+
+
+class uint64(int, struct_stream):
+    "unsigned 64-bit int"
+
+    PACK = "!Q"

chik_base/atoms/sized_bytes.py

@@ -0,0 +1,43 @@
+from typing import BinaryIO
+from .hexbytes import hexbytes
+
+
+class SizedBytes(hexbytes):
+    """
+    Intended to be subclassed, this base class makes it easy to create
+    subclasses of `bytes` that require the length to be a specific value.
+
+    Having a specific number of bytes means we can easily parse and stream
+    """
+
+    _size: int
+
+    def __new__(cls, v):
+        "`v` must be castable to `bytes`"
+        v = bytes(v)
+        if not isinstance(v, bytes) or len(v) != cls._size:
+            raise ValueError("bad %s initializer %s" % (cls.__name__, v))
+        return hexbytes.__new__(cls, v)
+
+    @classmethod
+    def parse(cls, f: BinaryIO) -> bytes:
+        b = f.read(cls._size)
+        if len(b) != cls._size:
+            msg = f"unexpected EOS: {len(b)} bytes read, {cls._size} expected"
+            raise ValueError(msg)
+        return cls(b)
+
+    @classmethod
+    def _class_stream(cls, obj: bytes, f: BinaryIO) -> None:
+        if len(obj) != cls._size:
+            msg = f"got {len(obj)} bytes when we expected {cls._size}"
+            raise ValueError(msg)
+        f.write(obj)
+
+
+class bytes32(SizedBytes):
+    """
+    A subclass of `bytes` that requires the length to be 32.
+    """
+
+    _size = 32

chik_base/atoms/struct_stream.py

@@ -0,0 +1,24 @@
+import struct
+
+from typing import BinaryIO, TypeVar, Type
+
+
+_T = TypeVar("_T", bound="struct_stream")
+
+
+class struct_stream:
+    """
+    This is a base class. Subclasses should define `cls.PACK` as a struct.pack
+    template string. In return, you get implementations of `parse` and
+    `_class_stream`.
+    """
+
+    PACK: str
+
+    @classmethod
+    def parse(cls: Type[_T], f: BinaryIO) -> _T:
+        return cls(*struct.unpack(cls.PACK, f.read(struct.calcsize(cls.PACK))))
+
+    @classmethod
+    def _class_stream(cls: Type[_T], obj: _T, f: BinaryIO) -> None:
+        f.write(struct.pack(cls.PACK, obj))

chik_base/bls12_381/__init__.py

@@ -0,0 +1,11 @@
+"""
+The `chik_rs` wheel has some rough edges in its api. This module smooths them over
+with a more ergonomic api.
+"""
+
+from .bls_public_key import BLSPublicKey
+from .bls_secret_exponent import BLSSecretExponent
+from .bls_signature import BLSSignature
+
+
+__all__ = ["BLSPublicKey", "BLSSecretExponent", "BLSSignature"]

chik_base/bls12_381/bls_public_key.py

@@ -0,0 +1,129 @@
+from typing import BinaryIO, List
+
+import chik_rs  # type: ignore
+
+from chik_base.atoms import hexbytes
+from chik_base.util.bech32 import bech32_decode, bech32_encode, Encoding
+
+from .secret_key_utils import public_key_from_int
+
+BECH32M_PUBLIC_KEY_PREFIX = "bls1238"
+
+
+class BLSPublicKey:
+    """
+    This corresponds to an element in bls12-381's G1 group, represented
+    when serialized by a 48-byte x element (with a few extra bits at the
+    beginning for metadata).
+    """
+    def __init__(self, g1: chik_rs.G1Element):
+        assert isinstance(g1, chik_rs.G1Element)
+        self._g1 = g1
+
+    @classmethod
+    def from_bytes(cls, blob):
+        "parse from a binary blob"
+        bls_public_hd_key = chik_rs.G1Element.from_bytes(blob)
+        return BLSPublicKey(bls_public_hd_key)
+
+    @classmethod
+    def parse(cls, f: BinaryIO):
+        "parse from a stream"
+        return cls.from_bytes(f.read(48))
+
+    @classmethod
+    def generator(cls):
+        "return the well-known generator"
+        return BLSPublicKey(chik_rs.G1Element.generator())
+
+    @classmethod
+    def zero(cls):
+        "return the well-known zero"
+        return cls(chik_rs.G1Element())
+
+    def stream(self, f: BinaryIO) -> None:
+        "write the serialized version to the file f"
+        f.write(bytes(self._g1))
+
+    def __add__(self, other):
+        "add two elements, returning the sum. Use `+`"
+        return BLSPublicKey(self._g1 + other._g1)
+
+    def __mul__(self, other: int):
+        "multiply an element by a scalar"
+        if other < 0:
+            raise ValueError("can't multiply by a negative value")
+        if self == self.generator():
+            # there is a special method in chik_rs that multiplies
+            # the generator by an integer that is not susceptible to
+            # timing attacks. Since public keys are generate times integer,
+            # using this method with the generator could expose to timing
+            # attacks. So instead we use the more clever code specifically
+            # for the generator
+            return BLSPublicKey(public_key_from_int(other))
+        if other == 0:
+            return self.zero()
+        if other == 1:
+            return self
+        # use recursion on `__mul__` in a sneaky clever way
+        parity = other & 1
+        v = self.__mul__(other >> 1)
+        v += v
+        if parity:
+            v += self
+        return v
+
+    def __rmul__(self, other: int):
+        return self.__mul__(other)
+
+    def __eq__(self, other):
+        if isinstance(other, type(self)):
+            return self._g1 == other._g1
+        return False
+
+    def __bytes__(self) -> bytes:
+        return hexbytes(self._g1)
+
+    def child(self, index: int) -> "BLSPublicKey":
+        "unhardened child derivation"
+        return BLSPublicKey(
+            chik_rs.AugSchemeMPL.derive_child_pk_unhardened(self._g1, index)
+        )
+
+    def child_for_path(self, path: List[int]) -> "BLSPublicKey":
+        "A path is a list of child integer derivations"
+        r = self
+        for index in path:
+            r = r.child(index)
+        return r
+
+    def fingerprint(self) -> int:
+        "return a 32-bit unsigned integer"
+        return self._g1.get_fingerprint()
+
+    def as_bech32m(self) -> str:
+        "convert to a bech32m string"
+        return bech32_encode(BECH32M_PUBLIC_KEY_PREFIX, bytes(self), Encoding.BECH32M)
+
+    @classmethod
+    def from_bech32m(cls, text: str) -> "BLSPublicKey":
+        "convert from a bech32m string"
+        r = bech32_decode(text, max_length=91)
+        if r is not None:
+            prefix, base8_data, encoding = r
+            if (
+                encoding == Encoding.BECH32M
+                and prefix == BECH32M_PUBLIC_KEY_PREFIX
+                and len(base8_data) == 49
+            ):
+                return cls.from_bytes(base8_data[:48])
+        raise ValueError("not bls12_381 bech32m pubkey")
+
+    def __hash__(self):
+        return bytes(self).__hash__()
+
+    def __str__(self):
+        return self.as_bech32m()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, self)

chik_base/bls12_381/bls_secret_exponent.py

@@ -0,0 +1,138 @@
+from typing import BinaryIO, List, Optional
+
+import chik_rs  # type: ignore
+
+from chik_base.util.bech32 import bech32_decode, bech32_encode, Encoding
+
+from .bls_public_key import BLSPublicKey
+from .bls_signature import BLSSignature
+from .secret_key_utils import private_key_from_int
+
+
+BECH32M_SECRET_EXPONENT_PREFIX = "se"
+
+
+class BLSSecretExponent:
+    """
+    This is essentially an `int` with convenience functions.
+
+    We don't subclass `int` because we have a different implementation of
+    `__bytes__` which could cause confusion.
+    """
+
+    def __init__(self, sk: chik_rs.PrivateKey):
+        self._sk = sk
+
+    @classmethod
+    def from_seed(cls, seed: bytes) -> "BLSSecretExponent":
+        """
+        convert from a seed using the specification at
+        https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-bls-signature-05
+        """
+        return BLSSecretExponent(chik_rs.AugSchemeMPL.key_gen(seed))
+
+    @classmethod
+    def from_int(cls, secret_exponent) -> "BLSSecretExponent":
+        "convert from the given int"
+        return cls(private_key_from_int(secret_exponent))
+
+    @classmethod
+    def from_bytes(cls, blob) -> "BLSSecretExponent":
+        "deserialize from the given blob. A blob of length 32 bytes is expected"
+        return cls(chik_rs.PrivateKey.from_bytes(blob))
+
+    @classmethod
+    def parse(cls, f: BinaryIO):
+        "deserialize from the given stream"
+        return cls.from_bytes(f.read(32))
+
+    def stream(self, f: BinaryIO) -> None:
+        "serialize to the given stream"
+        f.write(bytes(self._sk))
+
+    def fingerprint(self) -> int:
+        "return a 32-bit unsigned integer. The public key fingerprint will match."
+        return self._sk.get_g1().get_fingerprint()
+
+    def sign(
+        self, message: bytes, final_public_key: Optional[BLSPublicKey] = None
+    ) -> BLSSignature:
+        "generate a signature"
+        if final_public_key:
+            return BLSSignature(
+                chik_rs.AugSchemeMPL.sign(self._sk, message, final_public_key._g1)
+            )
+        return BLSSignature(chik_rs.AugSchemeMPL.sign(self._sk, message))
+
+    def public_key(self) -> BLSPublicKey:
+        "return the corresponding public key"
+        return BLSPublicKey(self._sk.get_g1())
+
+    def secret_exponent(self) -> int:
+        "return the exponent as an `int`"
+        return int.from_bytes(bytes(self), "big")
+
+    def hardened_child(self, index: int) -> "BLSSecretExponent":
+        "return the hardened child"
+        return BLSSecretExponent(chik_rs.AugSchemeMPL.derive_child_sk(self._sk, index))
+
+    def child(self, index: int) -> "BLSSecretExponent":
+        "return the unhardened child. This will match the corresponding public_key child"
+        return BLSSecretExponent(
+            chik_rs.AugSchemeMPL.derive_child_sk_unhardened(self._sk, index)
+        )
+
+    def child_for_path(self, path: List[int]) -> "BLSSecretExponent":
+        "A path is a list of child integer derivations. Unhardened only"
+        r = self
+        for index in path:
+            r = r.child(index)
+        return r
+
+    def as_bech32m(self):
+        "convert to a bech32m string"
+        return bech32_encode(
+            BECH32M_SECRET_EXPONENT_PREFIX, bytes(self), Encoding.BECH32M
+        )
+
+    @classmethod
+    def from_bech32m(cls, text: str) -> "BLSSecretExponent":
+        "convert from a bech32m string"
+        r = bech32_decode(text)
+        if r is not None:
+            prefix, base8_data, encoding = r
+            if (
+                encoding == Encoding.BECH32M
+                and prefix == BECH32M_SECRET_EXPONENT_PREFIX
+                and len(base8_data) == 33
+            ):
+                return cls.from_bytes(base8_data[:32])
+        raise ValueError("not secret exponent")
+
+    @classmethod
+    def zero(cls) -> "BLSSecretExponent":
+        "returns the secret exponent corresponding to 0. This shouldn't be used to sign"
+        return ZERO
+
+    def __add__(self, other):
+        return self.from_int(int(self) + int(other))
+
+    def __int__(self):
+        return self.secret_exponent()
+
+    def __eq__(self, other):
+        if isinstance(other, int):
+            other = BLSSecretExponent.from_int(other)
+        return self._sk == other._sk
+
+    def __bytes__(self):
+        return bytes(self._sk)
+
+    def __str__(self):
+        return "<prv for:%s>" % self.public_key()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, self)
+
+
+ZERO = BLSSecretExponent.from_int(0)

chik_base/bls12_381/bls_signature.py

@@ -0,0 +1,81 @@
+from dataclasses import dataclass
+from typing import BinaryIO, List, Sequence, Tuple
+
+import chik_rs  # type: ignore
+
+from chik_base.atoms import bytes32
+
+from .bls_public_key import BLSPublicKey
+
+ZERO96 = bytes([0] * 96)
+
+
+class BLSSignature:
+    """
+    This wraps the chik_rs version and resolves a couple edge cases
+    around aggregation and validation.
+    """
+
+    @dataclass
+    class aggsig_pair:
+        public_key: BLSPublicKey
+        message_hash: bytes
+
+    def __init__(self, g2: chik_rs.G2Element):
+        assert isinstance(g2, chik_rs.G2Element)
+        self._g2 = g2
+
+    @classmethod
+    def from_bytes(cls, blob):
+        "parse from a binary blob"
+        bls_public_hd_key = chik_rs.G2Element.from_bytes(blob)
+        return cls(bls_public_hd_key)
+
+    @classmethod
+    def parse(cls, f: BinaryIO):
+        "parse from a stream"
+        return cls.from_bytes(f.read(96))
+
+    @classmethod
+    def generator(cls):
+        "return the well-known generator"
+        return cls(chik_rs.G2Element.generator())
+
+    @classmethod
+    def zero(cls):
+        "returns the g2 element corresponding to 0. This shouldn't be used to sign"
+        return cls(chik_rs.G2Element())
+
+    def stream(self, f):
+        "write the serialized version to the file f"
+        f.write(bytes(self._g2))
+
+    def __add__(self, other):
+        "add two elements, returning the sum. Use `+`"
+        return self.__class__(self._g2 + other._g2)
+
+    def __eq__(self, other):
+        return self._g2 == other._g2
+
+    def __bytes__(self) -> bytes:
+        return bytes(self._g2)
+
+    def __str__(self):
+        return bytes(self._g2).hex()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, self)
+
+    def validate(self, hash_key_pairs: Sequence[aggsig_pair]) -> bool:
+        "check signature"
+        return self.verify([(_.public_key, _.message_hash) for _ in hash_key_pairs])
+
+    def verify(self, hash_key_pairs: Sequence[Tuple[BLSPublicKey, bytes]]) -> bool:
+        "check signature"
+        hkp = list(hash_key_pairs)
+        public_keys: List[chik_rs.G1Element] = [_[0]._g1 for _ in hkp]
+        message_hashes: List[bytes32] = [_[1] for _ in hkp]
+
+        return chik_rs.AugSchemeMPL.aggregate_verify(
+            public_keys, message_hashes, self._g2
+        )

chik_base/bls12_381/secret_key_utils.py

@@ -0,0 +1,24 @@
+"""
+Some secret key utilities that need to know the group order and return `chik_rs`
+structures.
+"""
+
+
+import chik_rs  # type: ignore
+
+
+GROUP_ORDER = (
+    52435875175126190479447740508185965837690552500527637822603658699938581184513
+)
+
+
+def private_key_from_int(secret_exponent: int) -> chik_rs.PrivateKey:
+    "convert an `int` into the `chik_rs.PrivateKey`"
+    secret_exponent %= GROUP_ORDER
+    blob = secret_exponent.to_bytes(32, "big")
+    return chik_rs.PrivateKey.from_bytes(blob)
+
+
+def public_key_from_int(secret_exponent: int) -> chik_rs.G1Element:
+    "convert an `int` into the corresponding `chik_rs.G1Element` multiple of generator"
+    return private_key_from_int(secret_exponent).get_g1()

chik_base/cbincode/__init__.py

@@ -0,0 +1,43 @@
+"""
+Implement `cbincode` streaming and parsing.
+
+This is a very simple serialization standard. It's almost identical to the
+bincode standard implemented by a rust crate and described here:
+
+https://github.com/bincode-org/bincode/blob/trunk/docs/spec.md
+
+It uses `FixintEncoding`, ie. a fixed size for each of `(uint/int)(8|16|32)`.
+The bincode standard uses uint32 for size prefixes (on lists, for example) and
+the cbincode standard uses uint16. Other than that, the encoding has very few
+surprises.
+
+
+Parsers and streamers are created at runtime based on a type.
+
+Supported types include:
+
+- `bytes`, `str`
+- any class with a `.parse` class function
+  - this includes, `(u)?int(8|16|32)`, `bytes32`
+- `list[T]` where `T` is supported
+- `tuple[T1, T2, ..., TN]` where each `Tn` is supported
+- `Optional[T]` where `T` is supported (also spelled `T | None`)
+- classes decorated with `@dataclass` where each field is of a supported type
+
+Transitive closures of the above list are also supported.
+"""
+
+from .parser import make_parser, ParseFunction
+from .streamer import make_streamer, StreamFunction
+from .util import from_bytes, from_hex, to_bytes, to_hex
+
+__all__ = [
+    "make_parser",
+    "make_streamer",
+    "ParseFunction",
+    "StreamFunction",
+    "from_hex",
+    "from_bytes",
+    "to_hex",
+    "to_bytes",
+]