wallet-privacy-testkit 0.1.0__py3-none-any.whl

wallet_privacy_testkit/__init__.py

@@ -0,0 +1,3 @@
+"""Adversarial network tests for wallets and indexers."""
+
+__version__ = "0.1.0"

wallet_privacy_testkit/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+main()

wallet_privacy_testkit/capture.py

@@ -0,0 +1,213 @@
+"""Record observable TLS lengths and timing while forwarding bytes unchanged."""
+
+import json
+import selectors
+import socket
+import socketserver
+import threading
+import time
+from pathlib import Path
+
+TLS_HEADER_BYTES = 5
+TLS_MAX_CIPHERTEXT_BYTES = 18_432
+TLS_CONTENT_TYPES = frozenset((20, 21, 22, 23, 24))
+TLS_APPLICATION_DATA = 23
+VALID_DIRECTIONS = ("c2s", "s2c")
+
+
+class TLSRecordParser:
+    """Reassemble visible TLS record headers across arbitrary TCP reads."""
+
+    def __init__(self):
+        self.buffer = bytearray()
+        self.invalid = False
+
+    def feed(self, payload):
+        if self.invalid:
+            return []
+        self.buffer.extend(payload)
+        records = []
+        while len(self.buffer) >= TLS_HEADER_BYTES:
+            content_type = self.buffer[0]
+            major_version = self.buffer[1]
+            ciphertext_bytes = int.from_bytes(self.buffer[3:5], "big")
+            if (
+                content_type not in TLS_CONTENT_TYPES
+                or major_version != 3
+                or ciphertext_bytes > TLS_MAX_CIPHERTEXT_BYTES
+            ):
+                self.buffer.clear()
+                self.invalid = True
+                raise ValueError("stream does not have supported TLS record framing")
+            record_bytes = ciphertext_bytes + TLS_HEADER_BYTES
+            if len(self.buffer) < record_bytes:
+                break
+            records.append(
+                {"content_type": content_type, "record_bytes": record_bytes}
+            )
+            del self.buffer[:record_bytes]
+        return records
+
+
+class TraceRecorder:
+    """Write metadata-only JSON Lines events to a new file."""
+
+    def __init__(self, path):
+        self.path = Path(path)
+        self.file = self.path.open("x", encoding="utf-8")
+        self.lock = threading.Lock()
+        self.connection_count = 0
+
+    def emit(self, event, connection, **fields):
+        with self.lock:
+            row = {
+                "event": event,
+                "connection": connection,
+                "t_ns": time.monotonic_ns(),
+                **fields,
+            }
+            self.file.write(json.dumps(row, separators=(",", ":")) + "\n")
+            self.file.flush()
+
+    def next_connection(self):
+        with self.lock:
+            self.connection_count += 1
+            return self.connection_count
+
+    def close(self):
+        with self.lock:
+            if not self.file.closed:
+                self.file.close()
+
+
+class TLSForwarder(socketserver.ThreadingTCPServer):
+    allow_reuse_address = True
+    daemon_threads = False
+    block_on_close = True
+
+    def __init__(self, target, recorder, listen_host="127.0.0.1", listen_port=0):
+        self.target = target
+        self.recorder = recorder
+        self.stopping = threading.Event()
+        super().__init__((listen_host, listen_port), _ForwardHandler)
+        self.worker = threading.Thread(target=self.serve_forever, daemon=True)
+        self.worker.start()
+
+    def close(self):
+        self.stopping.set()
+        self.shutdown()
+        self.server_close()
+        self.worker.join()
+
+
+class _ForwardHandler(socketserver.BaseRequestHandler):
+    def handle(self):
+        server = self.server
+        recorder = server.recorder
+        connection = recorder.next_connection()
+        recorder.emit("connect", connection)
+        try:
+            with socket.create_connection(server.target, timeout=5) as upstream:
+                endpoints = (self.request, upstream)
+                for endpoint in endpoints:
+                    endpoint.settimeout(5)
+                    endpoint.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
+                parsers = {direction: TLSRecordParser() for direction in VALID_DIRECTIONS}
+                with selectors.DefaultSelector() as selector:
+                    selector.register(self.request, selectors.EVENT_READ, (upstream, "c2s"))
+                    selector.register(upstream, selectors.EVENT_READ, (self.request, "s2c"))
+                    while not server.stopping.is_set():
+                        for key, _ in selector.select(timeout=0.1):
+                            destination, direction = key.data
+                            payload = key.fileobj.recv(65_536)
+                            if not payload:
+                                return
+                            recorder.emit(
+                                "chunk", connection, direction=direction, bytes=len(payload)
+                            )
+                            try:
+                                for record in parsers[direction].feed(payload):
+                                    recorder.emit(
+                                        "tls_record", connection, direction=direction, **record
+                                    )
+                            except ValueError:
+                                recorder.emit("parse_error", connection, direction=direction)
+                            destination.sendall(payload)
+        except OSError as error:
+            if not server.stopping.is_set():
+                recorder.emit(
+                    "connection_error", connection, error=type(error).__name__
+                )
+        finally:
+            recorder.emit("close", connection)
+
+
+def read_trace(path):
+    rows = []
+    with Path(path).open(encoding="utf-8") as source:
+        for line_number, line in enumerate(source, 1):
+            try:
+                row = json.loads(line)
+            except json.JSONDecodeError as error:
+                raise ValueError(f"invalid JSON at line {line_number}") from error
+            if not isinstance(row, dict) or "event" not in row:
+                raise ValueError(f"invalid trace event at line {line_number}")
+            rows.append(row)
+    if not rows:
+        raise ValueError("trace is empty")
+    return rows
+
+
+def summarize_trace(path, require_complete=True):
+    events = read_trace(path)
+    failures = [
+        row for row in events if row["event"] in ("parse_error", "connection_error")
+    ]
+    if failures:
+        kinds = sorted({row["event"] for row in failures})
+        raise ValueError(f"trace contains capture failures: {', '.join(kinds)}")
+    chunks = [row for row in events if row["event"] == "chunk"]
+    records = [row for row in events if row["event"] == "tls_record"]
+    if not chunks or not records:
+        raise ValueError("trace has no captured TLS traffic")
+    totals = {}
+    for direction in VALID_DIRECTIONS:
+        chunk_bytes = sum(
+            row["bytes"] for row in chunks if row.get("direction") == direction
+        )
+        record_bytes = sum(
+            row["record_bytes"]
+            for row in records
+            if row.get("direction") == direction
+        )
+        if require_complete and chunk_bytes != record_bytes:
+            raise ValueError(
+                f"incomplete {direction} TLS record accounting: "
+                f"{chunk_bytes} chunk bytes, {record_bytes} complete record bytes"
+            )
+        totals[direction] = {
+            "chunk_bytes": chunk_bytes,
+            "complete_record_bytes": record_bytes,
+        }
+    application_records = [
+        row
+        for row in records
+        if row.get("direction") == "c2s"
+        and row.get("content_type") == TLS_APPLICATION_DATA
+    ]
+    if not application_records:
+        raise ValueError("trace has no client application-data record")
+    return {
+        "connections": sum(row["event"] == "connect" for row in events),
+        "client_bytes": totals["c2s"]["chunk_bytes"],
+        "server_bytes": totals["s2c"]["chunk_bytes"],
+        "largest_client_application_record": max(
+            row["record_bytes"] for row in application_records
+        ),
+        "complete_tls_records": len(records),
+        "complete_accounting": all(
+            totals[direction]["chunk_bytes"]
+            == totals[direction]["complete_record_bytes"]
+            for direction in VALID_DIRECTIONS
+        ),
+    }

wallet_privacy_testkit/cli.py

@@ -0,0 +1,147 @@
+"""Command-line entry point for the privacy testkit."""
+
+import argparse
+import json
+import time
+from pathlib import Path
+
+from . import __version__
+from .capture import TLSForwarder, TraceRecorder, summarize_trace
+from .fault_relay import FAULT_MODES, SendTransactionRelay
+from .matching import evaluate_size_matching
+
+
+def _port(value, *, allow_zero=False):
+    port = int(value)
+    minimum = 0 if allow_zero else 1
+    if not minimum <= port <= 65_535:
+        label = "0..65535" if allow_zero else "1..65535"
+        raise argparse.ArgumentTypeError(f"port must be in {label}")
+    return port
+
+
+def _listen_port(value):
+    return _port(value, allow_zero=True)
+
+
+def _write_new(path, value):
+    with Path(path).open("x", encoding="utf-8") as destination:
+        json.dump(value, destination, indent=2)
+        destination.write("\n")
+
+
+def _capture(args):
+    recorder = TraceRecorder(args.output)
+    forwarder = TLSForwarder(
+        (args.target_host, args.target_port),
+        recorder,
+        args.listen_host,
+        args.listen_port,
+    )
+    print(
+        json.dumps(
+            {
+                "ready": True,
+                "listen_host": forwarder.server_address[0],
+                "listen_port": forwarder.server_address[1],
+                "trace": str(args.output),
+            }
+        ),
+        flush=True,
+    )
+    try:
+        while True:
+            time.sleep(0.2)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        forwarder.close()
+        recorder.close()
+
+
+def _summarize(args):
+    print(json.dumps(summarize_trace(args.trace, not args.allow_partial), indent=2))
+
+
+def _match(args):
+    samples = json.loads(args.samples.read_text(encoding="utf-8"))
+    print(
+        json.dumps(
+            evaluate_size_matching(samples, training_batch=args.training_batch), indent=2
+        )
+    )
+
+
+def _fault_relay(args):
+    if args.events.exists():
+        raise FileExistsError(f"event output already exists: {args.events}")
+    relay = SendTransactionRelay(
+        args.upstream,
+        args.mode,
+        upstream_ca=args.upstream_ca,
+        listen_host=args.listen_host,
+        listen_port=args.listen_port,
+        certificate=args.certificate,
+        private_key=args.private_key,
+    )
+    print(
+        json.dumps({"ready": True, "endpoint": relay.endpoint, "mode": args.mode}),
+        flush=True,
+    )
+    try:
+        while True:
+            time.sleep(0.2)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        relay.close()
+        _write_new(args.events, relay.events)
+
+
+def parser():
+    root = argparse.ArgumentParser(
+        prog="wpt", description="Adversarial network tests for Zcash wallets"
+    )
+    root.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+    commands = root.add_subparsers(dest="command", required=True)
+
+    capture = commands.add_parser("capture", help="record passive TLS metadata")
+    capture.add_argument("--target-host", required=True)
+    capture.add_argument("--target-port", required=True, type=_port)
+    capture.add_argument("--listen-host", default="127.0.0.1")
+    capture.add_argument("--listen-port", default=0, type=_listen_port)
+    capture.add_argument("--output", required=True, type=Path)
+    capture.set_defaults(handler=_capture)
+
+    summarize = commands.add_parser("summarize", help="validate and summarize a trace")
+    summarize.add_argument("trace", type=Path)
+    summarize.add_argument("--allow-partial", action="store_true")
+    summarize.set_defaults(handler=_summarize)
+
+    matching = commands.add_parser("match", help="evaluate size-only candidate matching")
+    matching.add_argument("samples", type=Path)
+    matching.add_argument("--training-batch", default=0, type=int)
+    matching.set_defaults(handler=_match)
+
+    relay = commands.add_parser(
+        "fault-relay", help="inject SendTransaction delivery uncertainty"
+    )
+    relay.add_argument("--upstream", required=True, help="host:port")
+    relay.add_argument("--mode", required=True, choices=sorted(FAULT_MODES))
+    relay.add_argument("--upstream-ca", type=Path)
+    relay.add_argument("--listen-host", default="127.0.0.1")
+    relay.add_argument("--listen-port", default=0, type=_listen_port)
+    relay.add_argument("--certificate", type=Path)
+    relay.add_argument("--private-key", type=Path)
+    relay.add_argument("--events", required=True, type=Path)
+    relay.set_defaults(handler=_fault_relay)
+    return root
+
+
+def main():
+    args = parser().parse_args()
+    args.handler(args)
+
+
+if __name__ == "__main__":
+    main()

wallet_privacy_testkit/fault_relay.py

@@ -0,0 +1,155 @@
+"""A protocol-aware relay for uncertain SendTransaction delivery tests."""
+
+import concurrent.futures
+import hashlib
+import threading
+import time
+from pathlib import Path
+
+import grpc
+
+from .protocol import RawTransaction, SEND_TRANSACTION, SendResponse
+
+FAULT_MODES = frozenset(("before-once", "after-once", "after-all"))
+LIGHTWALLET_PROTOCOL_VERSION = "v0.5.0"
+SERVER_STREAMING_METHODS = frozenset(
+    (
+        "GetBlockRange",
+        "GetBlockRangeNullifiers",
+        "GetTaddressTxids",
+        "GetTaddressTransactions",
+        "GetMempoolTx",
+        "GetMempoolStream",
+        "GetSubtreeRoots",
+        "GetAddressUtxosStream",
+    )
+)
+CLIENT_STREAMING_METHOD = "GetTaddressBalanceStream"
+
+
+class SendTransactionRelay(grpc.GenericRpcHandler):
+    """Forward the service and fail acknowledgements at declared boundaries."""
+
+    def __init__(
+        self,
+        upstream,
+        mode,
+        *,
+        upstream_ca=None,
+        listen_host="127.0.0.1",
+        listen_port=0,
+        certificate=None,
+        private_key=None,
+        ready_timeout=15,
+    ):
+        if mode not in FAULT_MODES:
+            raise ValueError(f"unknown fault mode: {mode}")
+        if (certificate is None) != (private_key is None):
+            raise ValueError("certificate and private key must be supplied together")
+        self.mode = mode
+        self.events = []
+        self.lock = threading.Lock()
+        if upstream_ca is None:
+            self.channel = grpc.insecure_channel(upstream)
+        else:
+            roots = Path(upstream_ca).read_bytes()
+            self.channel = grpc.secure_channel(
+                upstream, grpc.ssl_channel_credentials(root_certificates=roots)
+            )
+        grpc.channel_ready_future(self.channel).result(timeout=ready_timeout)
+        self.server = grpc.server(concurrent.futures.ThreadPoolExecutor(max_workers=16))
+        self.server.add_generic_rpc_handlers((self,))
+        address = f"{listen_host}:{listen_port}"
+        if certificate is None:
+            self.port = self.server.add_insecure_port(address)
+            self.scheme = "http"
+        else:
+            credentials = grpc.ssl_server_credentials(
+                ((Path(private_key).read_bytes(), Path(certificate).read_bytes()),)
+            )
+            self.port = self.server.add_secure_port(address, credentials)
+            self.scheme = "https"
+        if not self.port:
+            self.channel.close()
+            raise RuntimeError(f"could not bind relay to {address}")
+        self.server.start()
+
+    @property
+    def endpoint(self):
+        return f"{self.scheme}://127.0.0.1:{self.port}"
+
+    def service(self, details):
+        method = details.method
+        name = method.rsplit("/", 1)[-1]
+        if name in SERVER_STREAMING_METHODS:
+            return grpc.unary_stream_rpc_method_handler(
+                lambda request, context: self._forward_stream(method, request, context)
+            )
+        if name == CLIENT_STREAMING_METHOD:
+            return grpc.stream_unary_rpc_method_handler(
+                lambda requests, context: self._forward_client_stream(
+                    method, requests, context
+                )
+            )
+        return grpc.unary_unary_rpc_method_handler(
+            lambda request, context: self._forward_unary(method, request, context)
+        )
+
+    def _forward_stream(self, method, request, context):
+        try:
+            yield from self.channel.unary_stream(method)(request, timeout=120)
+        except grpc.RpcError as error:
+            context.abort(error.code(), error.details())
+
+    def _forward_client_stream(self, method, requests, context):
+        try:
+            return self.channel.stream_unary(method)(requests, timeout=120)
+        except grpc.RpcError as error:
+            context.abort(error.code(), error.details())
+
+    def _forward_unary(self, method, request, context):
+        event = None
+        if method == SEND_TRANSACTION:
+            transaction = RawTransaction.FromString(request)
+            with self.lock:
+                event = {
+                    "attempt": len(self.events) + 1,
+                    "time_ns": time.monotonic_ns(),
+                    "transaction_sha256": hashlib.sha256(transaction.data).hexdigest(),
+                    "transaction_bytes": len(transaction.data),
+                    "height": transaction.height,
+                }
+                self.events.append(event)
+            if self.mode == "before-once" and event["attempt"] == 1:
+                event["forwarded"] = False
+                context.abort(
+                    grpc.StatusCode.UNAVAILABLE,
+                    "privacy-testkit: connection lost before upstream submission",
+                )
+            event["forwarded"] = True
+        try:
+            response = self.channel.unary_unary(method)(request, timeout=120)
+        except grpc.RpcError as error:
+            if event is not None:
+                event["upstream_grpc_error"] = error.code().name
+            context.abort(error.code(), error.details())
+        if event is not None:
+            decoded = SendResponse.FromString(response)
+            event["upstream_response"] = {
+                "error_code": decoded.errorCode,
+                "message": decoded.errorMessage,
+            }
+            lose_response = self.mode == "after-all" or (
+                self.mode == "after-once" and event["attempt"] == 1
+            )
+            event["response_lost"] = lose_response
+            if lose_response:
+                context.abort(
+                    grpc.StatusCode.UNAVAILABLE,
+                    "privacy-testkit: response lost after upstream submission",
+                )
+        return response
+
+    def close(self, grace=0):
+        self.server.stop(grace).wait()
+        self.channel.close()

wallet_privacy_testkit/matching.py

@@ -0,0 +1,84 @@
+"""Conservative size-only matching with fractional credit for ties."""
+
+import statistics
+
+REQUIRED_FIELDS = frozenset(("id", "batch", "observed_bytes", "transaction_bytes"))
+
+
+def evaluate_size_matching(samples, training_batch=0):
+    if not isinstance(samples, list) or not samples:
+        raise ValueError("samples must be a non-empty JSON array")
+    identifiers = set()
+    for index, sample in enumerate(samples):
+        if not isinstance(sample, dict):
+            raise ValueError(f"sample {index} is not an object")
+        missing = REQUIRED_FIELDS.difference(sample)
+        if missing:
+            raise ValueError(f"sample {index} is missing: {', '.join(sorted(missing))}")
+        if not isinstance(sample["id"], str) or not sample["id"]:
+            raise ValueError(f"sample {index} has an invalid id")
+        if sample["id"] in identifiers:
+            raise ValueError(f"duplicate sample id: {sample['id']}")
+        identifiers.add(sample["id"])
+        if type(sample["batch"]) is not int or sample["batch"] < 0:
+            raise ValueError(f"sample {index} has an invalid batch")
+        if not all(
+            type(sample[field]) is int and sample[field] >= 0
+            for field in ("observed_bytes", "transaction_bytes")
+        ):
+            raise ValueError(f"sample {index} has invalid byte counts")
+    training = [sample for sample in samples if sample["batch"] == training_batch]
+    if not training:
+        raise ValueError("training batch is absent")
+    held_out = [sample for sample in samples if sample["batch"] != training_batch]
+    if not held_out:
+        raise ValueError("held-out samples are absent")
+    offset = statistics.median(
+        sample["observed_bytes"] - sample["transaction_bytes"]
+        for sample in training
+    )
+    scores = []
+    for sample in held_out:
+        candidates = [row for row in samples if row["batch"] == sample["batch"]]
+        if len(candidates) < 2:
+            raise ValueError(f"batch {sample['batch']} has fewer than two candidates")
+        distances = [
+            abs(sample["observed_bytes"] - (candidate["transaction_bytes"] + offset))
+            for candidate in candidates
+        ]
+        best = min(distances)
+        tied = [
+            candidate
+            for candidate, distance in zip(candidates, distances)
+            if distance == best
+        ]
+        credit = 1 / len(tied) if sample["id"] in {row["id"] for row in tied} else 0
+        scores.append(
+            {
+                "id": sample["id"],
+                "batch": sample["batch"],
+                "credit": credit,
+                "tied_candidates": len(tied),
+                "absolute_size_error": abs(
+                    sample["observed_bytes"]
+                    - sample["transaction_bytes"]
+                    - offset
+                ),
+            }
+        )
+    batch_sizes = {
+        sample["batch"]: sum(row["batch"] == sample["batch"] for row in samples)
+        for sample in held_out
+    }
+    random_reference = statistics.mean(
+        1 / batch_sizes[sample["batch"]] for sample in held_out
+    )
+    return {
+        "training_batch": training_batch,
+        "training_samples": len(training),
+        "held_out_samples": len(held_out),
+        "learned_offset_bytes": offset,
+        "fractional_top1": statistics.mean(score["credit"] for score in scores),
+        "random_reference": random_reference,
+        "scores": scores,
+    }

wallet_privacy_testkit/protocol.py

@@ -0,0 +1,33 @@
+"""The small part of the lightwalletd protocol needed by the fault relay."""
+
+from google.protobuf import descriptor_pb2, descriptor_pool, message_factory
+
+SERVICE = "cash.z.wallet.sdk.rpc.CompactTxStreamer"
+SEND_TRANSACTION = f"/{SERVICE}/SendTransaction"
+
+
+def _message_classes():
+    schema = descriptor_pb2.FileDescriptorProto(
+        name="wallet_privacy_testkit.proto",
+        package="cash.z.wallet.sdk.rpc",
+        syntax="proto3",
+    )
+    definitions = (
+        ("RawTransaction", (("data", 1, 12), ("height", 2, 4))),
+        ("SendResponse", (("errorCode", 1, 5), ("errorMessage", 2, 9))),
+    )
+    for name, fields in definitions:
+        message = schema.message_type.add(name=name)
+        for field_name, number, field_type in fields:
+            message.field.add(name=field_name, number=number, type=field_type, label=1)
+    pool = descriptor_pool.DescriptorPool()
+    pool.Add(schema)
+    return tuple(
+        message_factory.GetMessageClass(
+            pool.FindMessageTypeByName(f"cash.z.wallet.sdk.rpc.{name}")
+        )
+        for name in ("RawTransaction", "SendResponse")
+    )
+
+
+RawTransaction, SendResponse = _message_classes()

wallet_privacy_testkit-0.1.0.dist-info/METADATA

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: wallet-privacy-testkit
+Version: 0.1.0
+Summary: Adversarial network privacy and transaction-delivery tests for Zcash wallets
+Author: Wallet Privacy Testkit contributors
+License-Expression: MIT OR Apache-2.0
+Project-URL: Homepage, https://github.com/ztsalexey/wallet-privacy-testkit
+Project-URL: Repository, https://github.com/ztsalexey/wallet-privacy-testkit
+Project-URL: Issues, https://github.com/ztsalexey/wallet-privacy-testkit/issues
+Project-URL: Changelog, https://github.com/ztsalexey/wallet-privacy-testkit/blob/main/CHANGELOG.md
+Keywords: zcash,wallet,privacy,testing,grpc,tls
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Security
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Requires-Dist: grpcio<2,>=1.70
+Requires-Dist: protobuf<8,>=5
+Dynamic: license-file
+
+# Wallet Privacy Testkit for Zcash
+
+Wallet Privacy Testkit is an adversarial test layer for Zcash wallet-to-indexer traffic. It records the lengths and timing visible outside TLS, injects uncertainty around `SendTransaction`, and evaluates size-only transaction matching without awarding full credit to ties.
+
+This is an independent project maintained at [ztsalexey/wallet-privacy-testkit](https://github.com/ztsalexey/wallet-privacy-testkit). It is not affiliated with or endorsed by the Zcash Foundation, Electric Coin Company, or any wallet or indexer maintainer.
+
+Version 0.1.0 is a research preview. It supplies reusable test components and a verified Zingolib case study. It does not certify a wallet, assign a privacy score, inspect mainnet funds, or replace a wallet's existing integration tests.
+
+## Why this exists
+
+A shielded transaction can hide its participants and value on-chain while its network behavior still leaks information. A second failure mode appears when a node accepts a payment but the wallet loses the response. The wallet must distinguish rejection from an unknown outcome and recover without creating another payment.
+
+Existing projects already provision Zcash regtest networks and test wallet behavior. This testkit attaches to those environments and contributes two narrower capabilities:
+
+- passive ciphertext metadata capture, without TLS keys or payload logging;
+- protocol-aware failure injection before or after transaction submission.
+
+The [methodology](docs/METHODOLOGY.md) defines what each result means. The [threat model](docs/THREAT_MODEL.md) states what it does not establish.
+
+## Install from a source checkout
+
+Python 3.11 or newer is required.
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+.venv/bin/python -m pip install -r requirements-dev.txt
+.venv/bin/python -m pip install --no-deps -e .
+.venv/bin/python -m unittest discover -s tests -v
+```
+
+The release was developed with Python 3.12.9, gRPC 1.83.1, and protobuf 7.36.1. CI tests the pinned development environment on Python 3.11–3.13 on Linux and macOS. The broader runtime dependency ranges are not exhaustively tested.
+
+Packaged wheels and source archives are available from [GitHub Releases](https://github.com/ztsalexey/wallet-privacy-testkit/releases). After activating a virtual environment, install a downloaded wheel with `python -m pip install ./wallet_privacy_testkit-0.1.0-py3-none-any.whl`.
+
+## Passive TLS metadata capture
+
+Point a wallet at the printed local port while the target indexer remains at `localhost:9067`:
+
+```sh
+wpt capture \
+  --target-host localhost \
+  --target-port 9067 \
+  --listen-port 7443 \
+  --output trace.jsonl
+```
+
+Stop the capture with Ctrl-C, then validate that every captured TCP byte belongs to a complete TLS record:
+
+```sh
+wpt summarize trace.jsonl
+```
+
+The forwarder copies bytes unchanged. Its trace contains connection numbers, monotonic timestamps, directions, byte counts, TLS content types, and TLS record lengths. It does not terminate TLS, store addresses, or record packet contents. A process boundary supplied by the test operator is still side information and must be disclosed in a report.
+
+## Transaction delivery faults
+
+The semantic relay terminates a test TLS connection and forwards the real gRPC service. It understands only enough of the lightwalletd protocol to identify and hash `RawTransaction.data`; it never writes signed transaction bytes. All other known RPCs are forwarded as opaque bytes using their required streaming cardinality.
+
+The forwarding table was checked against canonical `lightwallet-protocol` v0.5.0. A later protocol version that adds a streaming RPC requires a testkit update before that RPC can pass through correctly.
+
+For a TLS upstream and TLS-facing wallet:
+
+```sh
+wpt fault-relay \
+  --upstream localhost:9067 \
+  --upstream-ca test-ca.pem \
+  --certificate localhost.pem \
+  --private-key localhost.key \
+  --mode after-once \
+  --events events.json
+```
+
+The supported modes are:
+
+| Mode | Behavior |
+| --- | --- |
+| `before-once` | Fail the first submission without forwarding it, then forward normally |
+| `after-once` | Forward the first submission and discard its response, then forward normally |
+| `after-all` | Forward every submission and discard every response |
+
+Use the relay only with disposable wallets and isolated regtest funds. The tool deliberately changes transaction-delivery behavior. The test operator remains responsible for checking the node's mempool or chain and the wallet's eventual state.
+
+An insecure local upstream or client can omit the certificate options. The relay binds to `127.0.0.1` by default. Supplying only one of `--certificate` and `--private-key` is rejected.
+
+The printed endpoint uses `127.0.0.1`. When the wallet-facing side uses TLS, the server certificate must therefore contain the IP address `127.0.0.1` in its Subject Alternative Name. The upstream CA file is required for a TLS upstream; omitting it selects an insecure upstream channel.
+
+## Size-only matching
+
+`wpt match samples.json` accepts a JSON array. Each row must contain a unique `id`, a `batch`, `observed_bytes`, and the corresponding public `transaction_bytes`. Batch 0 calibrates a single median byte offset by default. Every other observation is compared only with candidates in its own batch.
+
+```json
+[
+  {"id":"train-a","batch":0,"observed_bytes":9207,"transaction_bytes":9165},
+  {"id":"train-b","batch":0,"observed_bytes":12363,"transaction_bytes":12321},
+  {"id":"test-a","batch":1,"observed_bytes":9207,"transaction_bytes":9165},
+  {"id":"test-b","batch":1,"observed_bytes":12363,"transaction_bytes":12321}
+]
+```
+
+Nearest candidates share credit when their distance ties. A batch with fewer than two candidates is rejected because singleton identification says nothing about the matcher. The tool reports a random reference computed from each held-out batch's candidate count.
+
+## Verified case study
+
+The included [Zingolib v5 regtest report](evidence/zingolib-v5-regtest/REPORT.md) records 18 newly constructed shielded payments and three delivery-fault transactions in the complete run. The wallet reported a payment as failed after its acknowledgement was lost even though Zebra had accepted it. Mining and synchronization corrected the status to confirmed. Current Zingolib development code already includes related duplicate and delivery-check handling, so this is regression evidence rather than a claim of an unresolved current bug.
+
+The case study also found that encrypted lengths distinguished 1-, 2-, and 4-recipient transaction structures in a favorable observer model. Equal-structure payments tied at chance. The result does not estimate deanonymization in normal wallet traffic.
+
+## Project status
+
+The release boundary is intentionally small. Z3, Zcash Integration Tests, Regchest, and wallet-specific suites already cover network provisioning and broad functional behavior. The testkit is designed to complement them. See the [competitive and overlap review](docs/COMPETITIVE_LANDSCAPE.md) and [release checklist](docs/RELEASE_CHECKLIST.md).
+
+Upstream contributions should begin with a maintainer-acknowledged issue and a narrowly scoped regression, following the target repository's contribution policy.
+
+## License
+
+Licensed under either the MIT License or Apache License 2.0, at your option.

wallet_privacy_testkit-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+wallet_privacy_testkit/__init__.py,sha256=XZ6wQk-Tc5hBm1soZH9U0w7mOejAdY55QR1MewqrPmE,81
+wallet_privacy_testkit/__main__.py,sha256=bYt9eEaoRQWdejEHFD8REx9jxVEdZptECFsV7F49Ink,30
+wallet_privacy_testkit/capture.py,sha256=hT_PVZrDEIsluTWKCJi-EkE3tirI5sisW18nGZjl-As,7949
+wallet_privacy_testkit/cli.py,sha256=VU1wCQuHSpiDZYSQso0vUmoos2Y6mFRHLY8s-TCM-NM,4565
+wallet_privacy_testkit/fault_relay.py,sha256=0zYbKoFzsn3ZeluaXD3fNZHGDhjz_dltLlDPp15L0eY,5811
+wallet_privacy_testkit/matching.py,sha256=wI6dJFcQXGaDgaS-AcRAbafmKX9HIbNDbR8XFhHwQ6k,3442
+wallet_privacy_testkit/protocol.py,sha256=4U1BNq_-dw84_xCNCofDlrMN392_cgg0VUlJDTPz_HE,1164
+wallet_privacy_testkit-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=uCShXdhKlwJs-I5TyaeSX3_A44xesj4tEb9NNjbFReQ,11365
+wallet_privacy_testkit-0.1.0.dist-info/licenses/LICENSE-MIT,sha256=z5rJO6uPdxjtnRx9gWLdp8PgY-Uw4Bpp7bLubrif5C8,1092
+wallet_privacy_testkit-0.1.0.dist-info/METADATA,sha256=s8NDpnf7byMo_-M3iOeGlSjunaIH3g7ZRkqv9UHlKdA,8574
+wallet_privacy_testkit-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+wallet_privacy_testkit-0.1.0.dist-info/entry_points.txt,sha256=1hrkWScLyk1iycXspmMrKLFG2u9MBhsYFppMsej8b2o,56
+wallet_privacy_testkit-0.1.0.dist-info/top_level.txt,sha256=PCqW9TEZdvkrjJbCaCKWiRal6cnTaW2ADy2HC5zxfHU,23
+wallet_privacy_testkit-0.1.0.dist-info/RECORD,,

wallet_privacy_testkit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

wallet_privacy_testkit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+wpt = wallet_privacy_testkit.cli:main

wallet_privacy_testkit-0.1.0.dist-info/licenses/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Wallet Privacy Testkit contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

wallet_privacy_testkit-0.1.0.dist-info/licenses/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wallet Privacy Testkit contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wallet_privacy_testkit-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+wallet_privacy_testkit