"""The iroh rung's identity on the wire: its ALPN and its NodeAddr ticket.
Standard library only, no external dependencies.
Used across transport adapters, sidecars, and routers to identify an Iroh endpoint.
"""
from __future__ import annotations
import hashlib
import json
from typing import Optional
ALPN: str = 'fleetmesh/didcomm/1'
[docs]class IrohTicket:
"""An Iroh NodeAddr ticket identifying an Iroh endpoint.
Contains:
- node_id: Hex-encoded 32-byte Ed25519 transport key (iroh NodeId)
- host: Direct IP or hostname
- port: Direct listen port
- relay_url: Optional DERP / home relay URL
"""
[docs] def __init__(
self,
node_id: str,
host: str = '127.0.0.1',
port: int = 0,
relay_url: Optional[str] = None,
) -> None:
self.node_id: str = node_id.lower()
self.host: str = host
self.port: int = int(port)
self.relay_url: Optional[str] = relay_url
[docs] def encode(self) -> str:
"""Format ticket as a canonical string."""
if self.relay_url:
return f"iroh://{self.node_id}@{self.host}:{self.port}?relay={self.relay_url}"
return f"iroh://{self.node_id}@{self.host}:{self.port}"
[docs] @classmethod
def parse(cls, ticket_str: str, default_host: str = '127.0.0.1', default_port: int = 9012) -> IrohTicket:
"""Parse an Iroh ticket string in URL, prefix, JSON, or opaque format."""
s = str(ticket_str).strip()
if not s:
raise ValueError('empty iroh ticket')
# Format 1: iroh://<node_id>@<host>:<port>[?relay=...]
if s.startswith('iroh://'):
rest = s[len('iroh://'):]
relay_url = None
if '?relay=' in rest:
rest, relay_url = rest.split('?relay=', 1)
if '@' in rest:
node_id, host_port = rest.split('@', 1)
if ':' in host_port:
host, port_str = host_port.split(':', 1)
return cls(node_id=node_id, host=host, port=int(port_str), relay_url=relay_url)
return cls(node_id=node_id, host=host_port, port=default_port, relay_url=relay_url)
return cls(node_id=rest, host=default_host, port=default_port, relay_url=relay_url)
# Format 2: iroh_ticket_<node_id>_<host>_<port>
if s.startswith('iroh_ticket_'):
parts = s.split('_')
if len(parts) >= 5:
node_id = parts[2]
host = parts[3]
port = int(parts[4])
return cls(node_id=node_id, host=host, port=port)
if len(parts) >= 3:
return cls(node_id=parts[2], host=default_host, port=default_port)
# Format 3: JSON dictionary
if s.startswith('{') and s.endswith('}'):
try:
data = json.loads(s)
node_id = data.get('node_id') or ''
addrs = data.get('addrs', [])
host = default_host
port = default_port
if addrs and isinstance(addrs[0], str) and ':' in addrs[0]:
host, port_str = addrs[0].rsplit(':', 1)
port = int(port_str)
return cls(node_id=node_id, host=host, port=port, relay_url=data.get('relay_url'))
except (ValueError, TypeError, AttributeError):
# Not the JSON shape after all (bad JSON, a non-object, a
# non-numeric port): fall through to the opaque format,
# which is what this string is then.
pass
# Format 4: opaque ticket (e.g. ticket-one, iroh_ticket_sample)
# Deterministically derive a valid ticket for loopback testing
h = hashlib.sha256(s.encode('utf-8')).hexdigest()
derived_port = default_port
return cls(node_id=h[:64], host=default_host, port=derived_port)
def __eq__(self, other: object) -> bool:
if not isinstance(other, IrohTicket):
return False
return (self.node_id == other.node_id and
self.host == other.host and
self.port == other.port and
self.relay_url == other.relay_url)
def __repr__(self) -> str:
return f"<IrohTicket {self.encode()}>"
__all__ = ['ALPN', 'IrohTicket']