reticiulum-specification/tools/verify_destination_hash.py

"""
Verifier for SPEC.md S1.1, S1.2, S1.3.

Reads test-vectors/identities.json and, for each vector:
  - Loads the private-key bytes via RNS.Identity.from_bytes (the upstream API
    for the on-bytes form X25519_priv || Ed25519_priv).
  - Confirms identity.get_public_key() matches expected.public_key_hex
    (X25519_pub || Ed25519_pub).
  - Confirms identity.hash matches expected.identity_hash_hex
    (= SHA256(public_key)[:16]).
  - Confirms SHA256(SHA256(name)[:10] || identity_hash)[:16] equals
    expected.destination_hash_hex.
  - Cross-checks RNS.Destination.hash(identity_hash, *name.split(".")) ==
    expected.destination_hash_hex (i.e. upstream agrees with the by-hand recipe).
  - S1.3 round-trip: writes the identity via `to_file`, reads the bytes back
    from disk, confirms they are exactly the 64-byte X25519||Ed25519 concat
    with no header / version byte / checksum / encryption, then loads via
    `from_file` and confirms the resulting identity hash matches the original.

Exit code 0 on PASS, non-zero on FAIL.
"""

from __future__ import annotations

import hashlib
import json
import os
import sys
import tempfile

import RNS


REPO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
VEC_PATH  = os.path.join(REPO_ROOT, "test-vectors", "identities.json")


def fail(msg: str) -> None:
    print(f"FAIL: {msg}")
    sys.exit(1)


def verify_vector(v: dict) -> None:
    label   = v["label"]
    inputs  = v["inputs"]
    expect  = v["expected"]
    full    = v["destination_full_name"]

    prv = bytes.fromhex(inputs["private_key_hex"])
    if prv.hex() != inputs["x25519_priv_hex"] + inputs["ed25519_priv_hex"]:
        fail(f"{label}: private_key_hex != x25519_priv_hex||ed25519_priv_hex")

    identity = RNS.Identity.from_bytes(prv)
    if identity is None:
        fail(f"{label}: RNS.Identity.from_bytes returned None")

    if identity.get_public_key().hex() != expect["public_key_hex"]:
        fail(f"{label}: public_key mismatch\n"
             f"  got: {identity.get_public_key().hex()}\n"
             f"  want: {expect['public_key_hex']}")

    expected_idhash = hashlib.sha256(identity.get_public_key()).digest()[:16]
    if expected_idhash.hex() != expect["identity_hash_hex"]:
        fail(f"{label}: SHA256(public_key)[:16] != identity_hash")
    if identity.hash.hex() != expect["identity_hash_hex"]:
        fail(f"{label}: identity.hash != expected (RNS disagrees with manual)")

    name_hash_calc = hashlib.sha256(full.encode("utf-8")).digest()[:10]
    if name_hash_calc.hex() != expect["name_hash_hex"]:
        fail(f"{label}: name_hash for {full!r}: got {name_hash_calc.hex()} "
             f"want {expect['name_hash_hex']}")

    dest_calc = hashlib.sha256(name_hash_calc + identity.hash).digest()[:16]
    if dest_calc.hex() != expect["destination_hash_hex"]:
        fail(f"{label}: dest_hash recipe mismatch\n"
             f"  got:  {dest_calc.hex()}\n"
             f"  want: {expect['destination_hash_hex']}")

    rns_dest_hash = RNS.Destination.hash(identity.hash, *full.split("."))
    if rns_dest_hash.hex() != expect["destination_hash_hex"]:
        fail(f"{label}: RNS.Destination.hash != expected\n"
             f"  RNS.Destination.hash: {rns_dest_hash.hex()}\n"
             f"  want:                 {expect['destination_hash_hex']}")

    # S1.3: to_file / from_file round-trip + on-disk byte-order verification
    fp = tempfile.NamedTemporaryFile(delete=False)
    fp.close()
    try:
        if not identity.to_file(fp.name):
            fail(f"{label}: Identity.to_file returned False")

        with open(fp.name, "rb") as fh:
            disk = fh.read()

        if len(disk) != 64:
            fail(f"{label}: on-disk identity is {len(disk)} bytes, want 64 (no header/checksum)")

        # Per S1.3 the on-disk order is X25519_priv(32) || Ed25519_priv(32)
        if disk[:32].hex() != inputs["x25519_priv_hex"]:
            fail(f"{label}: on-disk bytes [0:32] != X25519 priv\n"
                 f"  got:  {disk[:32].hex()}\n"
                 f"  want: {inputs['x25519_priv_hex']}")
        if disk[32:].hex() != inputs["ed25519_priv_hex"]:
            fail(f"{label}: on-disk bytes [32:64] != Ed25519 priv\n"
                 f"  got:  {disk[32:].hex()}\n"
                 f"  want: {inputs['ed25519_priv_hex']}")

        # from_file must reconstitute the same identity_hash
        reloaded = RNS.Identity.from_file(fp.name)
        if reloaded is None:
            fail(f"{label}: Identity.from_file returned None")
        if reloaded.hash.hex() != expect["identity_hash_hex"]:
            fail(f"{label}: from_file identity hash mismatch\n"
                 f"  got:  {reloaded.hash.hex()}\n"
                 f"  want: {expect['identity_hash_hex']}")
    finally:
        os.unlink(fp.name)

    print(f"PASS {label}: identity, identity_hash, dest_hash, "
          "on-disk round-trip for {!r}".format(full))


def main():
    print(f"verify_destination_hash.py against RNS {RNS.__version__}")
    if not os.path.isfile(VEC_PATH):
        fail(f"Missing test-vectors file: {VEC_PATH}")

    with open(VEC_PATH, "r", encoding="utf-8") as f:
        payload = json.load(f)
    if "vectors" not in payload:
        fail(f"Bad test-vectors file: missing 'vectors' key")

    for vec in payload["vectors"]:
        verify_vector(vec)

    print(f"ALL PASS ({len(payload['vectors'])} identity vectors)")


if __name__ == "__main__":
    main()