File size: 14,620 Bytes
9abace2 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 | """
Binary append-only storage using Python struct.
Part of SOVEREIGN PYTHON LLM ENGINE
Two record types:
WORMRecord — evidence ledger entries (magic b'WORM')
CheckpointRec — agent state checkpoints (magic b'CKPT')
Format philosophy:
- Pure Python stdlib: struct, hashlib, pathlib, io
- Fixed-width binary headers — no text, no injection surface
- Append-only file mode ('ab') — OS enforces it
- Every record self-describing — magic + version + lengths
- Reader scans forward only — corrupt tail = truncate, not corrupt head
- Zero external deps
WORM Record wire layout (152 bytes fixed header + variable body):
Offset Len Type Field
0 4 bytes MAGIC = b'WORM'
4 1 uint8 VERSION = 1
5 1 uint8 FLAGS (reserved, 0x00)
6 2 uint16 BE event_type length
8 4 uint32 BE payload length
12 4 uint32 BE metadata length
16 8 uint64 BE timestamp (unix nanoseconds)
24 32 bytes prev_hash (zeros if first record)
56 32 bytes content_hash (blake2b-256 of payload)
88 64 bytes signature (Ed25519, or zeros if no key)
152 var utf-8 event_type string
152+E var bytes payload
152+E+P var bytes metadata (caller-encoded, raw bytes)
Checkpoint Record wire layout (128 bytes fixed header + variable body):
Offset Len Type Field
0 4 bytes MAGIC = b'CKPT'
4 1 uint8 VERSION = 1
5 1 uint8 FLAGS (reserved, 0x00)
6 2 uint16 BE checkpoint_id length
8 2 uint16 BE agent_id length
10 2 uint16 BE prev_id length (0 if first)
12 4 uint32 BE state length
16 8 uint64 BE step number
24 8 uint64 BE timestamp (unix nanoseconds)
32 32 bytes content_hash (blake2b-256 of state)
64 64 bytes signature (Ed25519, or zeros if no key)
128 var utf-8 checkpoint_id
128+C var utf-8 agent_id
128+C+A var utf-8 prev_id
128+C+A+V var bytes state (raw bytes, caller encodes)
"""
from __future__ import annotations
import hashlib
import struct
import time
from dataclasses import dataclass
from pathlib import Path
from typing import Any, Iterator
# ─────────────────────────────────────────────
# Constants
# ─────────────────────────────────────────────
WORM_MAGIC = b'WORM'
CKPT_MAGIC = b'CKPT'
VERSION = 0x01
FLAGS = 0x00
ZERO_HASH = b'\x00' * 32
ZERO_SIG = b'\x00' * 64
# struct format strings (big-endian)
# WORM fixed header: magic(4) ver(1) flags(1) elen(2) dlen(4) mlen(4) ts(8) prev(32) hash(32) sig(64)
WORM_HDR_FMT = '>4sBBHIIQ32s32s64s'
WORM_HDR_SIZE = struct.calcsize(WORM_HDR_FMT) # 152
# CKPT fixed header: magic(4) ver(1) flags(1) cid_len(2) aid_len(2) pid_len(2) slen(4) step(8) ts(8) hash(32) sig(64)
CKPT_HDR_FMT = '>4sBBHHHIQQ32s64s'
CKPT_HDR_SIZE = struct.calcsize(CKPT_HDR_FMT) # 128
assert WORM_HDR_SIZE == 152, f"WORM header size mismatch: {WORM_HDR_SIZE}"
assert CKPT_HDR_SIZE == 128, f"CKPT header size mismatch: {CKPT_HDR_SIZE}"
# ─────────────────────────────────────────────
# Helpers
# ─────────────────────────────────────────────
def _now_ns() -> int:
return time.time_ns()
def _blake2b(data: bytes) -> bytes:
return hashlib.blake2b(data, digest_size=32).digest()
def _sign(signing_key, data: bytes) -> bytes:
if signing_key is None:
return ZERO_SIG
try:
return signing_key.sign(data)[:64]
except Exception:
return ZERO_SIG
# ─────────────────────────────────────────────
# WORM Record
# ─────────────────────────────────────────────
@dataclass
class WORMRecord:
event_type: str
payload: bytes
metadata: bytes # raw bytes — caller decides encoding
timestamp_ns: int
prev_hash: bytes # 32 bytes
content_hash: bytes # 32 bytes blake2b of payload
signature: bytes # 64 bytes Ed25519 (or zeros)
@property
def timestamp_s(self) -> float:
return self.timestamp_ns / 1_000_000_000
class WORMFile:
"""
Append-only binary WORM ledger.
Usage:
wf = WORMFile(Path("ledger.worm"), signing_key=key)
wf.append("tool_call", b"raw payload", b"meta bytes")
for record in wf.scan():
print(record.event_type)
"""
def __init__(self, path: Path, signing_key=None):
self.path = path
self.signing_key = signing_key
self.path.parent.mkdir(parents=True, exist_ok=True)
self._last_hash: bytes = ZERO_HASH
self._record_count: int = 0
self._init_chain()
def _init_chain(self) -> None:
if not self.path.exists() or self.path.stat().st_size == 0:
return
# Scan to find last hash — only reads headers
for rec in self.scan():
self._last_hash = rec.content_hash
self._record_count += 1
def append(
self,
event_type: str,
payload: bytes,
metadata: bytes = b''
) -> WORMRecord:
event_bytes = event_type.encode('utf-8')
ts = _now_ns()
content_hash = _blake2b(payload)
# Sign: prev_hash || content_hash || timestamp_ns || event_type
sign_input = (
self._last_hash +
content_hash +
struct.pack('>Q', ts) +
event_bytes
)
sig = _sign(self.signing_key, sign_input)
hdr = struct.pack(
WORM_HDR_FMT,
WORM_MAGIC,
VERSION,
FLAGS,
len(event_bytes),
len(payload),
len(metadata),
ts,
self._last_hash,
content_hash,
sig
)
# 'ab' — append binary, atomic at OS level
with open(self.path, 'ab') as f:
f.write(hdr)
f.write(event_bytes)
f.write(payload)
f.write(metadata)
rec = WORMRecord(
event_type=event_type,
payload=payload,
metadata=metadata,
timestamp_ns=ts,
prev_hash=self._last_hash,
content_hash=content_hash,
signature=sig
)
self._last_hash = content_hash
self._record_count += 1
return rec
def scan(self) -> Iterator[WORMRecord]:
if not self.path.exists():
return
with open(self.path, 'rb') as f:
while True:
hdr_bytes = f.read(WORM_HDR_SIZE)
if not hdr_bytes:
break
if len(hdr_bytes) < WORM_HDR_SIZE:
break # truncated tail — stop cleanly
(magic, ver, flags, elen, dlen, mlen,
ts, prev_hash, content_hash, sig) = struct.unpack(
WORM_HDR_FMT, hdr_bytes
)
if magic != WORM_MAGIC:
break # corrupt record — stop
event_bytes = f.read(elen)
payload = f.read(dlen)
metadata = f.read(mlen)
if len(event_bytes) < elen or len(payload) < dlen:
break # truncated body
yield WORMRecord(
event_type=event_bytes.decode('utf-8', errors='replace'),
payload=payload,
metadata=metadata,
timestamp_ns=ts,
prev_hash=prev_hash,
content_hash=content_hash,
signature=sig
)
def verify_chain(self) -> tuple[bool, int]:
"""
Verify hash chain integrity.
Returns (is_valid, records_checked).
Does NOT verify signatures (requires public key).
"""
prev = ZERO_HASH
count = 0
for rec in self.scan():
if rec.prev_hash != prev:
return False, count
expected = _blake2b(rec.payload)
if rec.content_hash != expected:
return False, count
prev = rec.content_hash
count += 1
return True, count
def scan_by_type(self, event_type: str) -> Iterator[WORMRecord]:
for rec in self.scan():
if rec.event_type == event_type:
yield rec
def count(self) -> int:
return self._record_count
@property
def last_hash(self) -> bytes:
return self._last_hash
# ─────────────────────────────────────────────
# Checkpoint Record
# ─────────────────────────────────────────────
@dataclass
class CheckpointRecord:
checkpoint_id: str
agent_id: str
prev_id: str # empty string if first
state: bytes # raw bytes — caller encodes
step: int
timestamp_ns: int
content_hash: bytes # 32 bytes blake2b of state
signature: bytes # 64 bytes
@property
def timestamp_s(self) -> float:
return self.timestamp_ns / 1_000_000_000
class CheckpointFile:
"""
Append-only binary checkpoint store.
One file per agent: {agent_id}.ckpt
Records are append-only — old checkpoints are never overwritten.
Usage:
cf = CheckpointFile(Path("checkpoints/agent_1.ckpt"), signing_key=key)
cf.append("ckpt_uuid", "agent_1", "", state_bytes, step=0)
for rec in cf.scan():
print(rec.checkpoint_id, rec.step)
"""
def __init__(self, path: Path, signing_key=None):
self.path = path
self.signing_key = signing_key
self.path.parent.mkdir(parents=True, exist_ok=True)
def append(
self,
checkpoint_id: str,
agent_id: str,
prev_id: str,
state: bytes,
step: int
) -> CheckpointRecord:
cid_bytes = checkpoint_id.encode('utf-8')
aid_bytes = agent_id.encode('utf-8')
pid_bytes = prev_id.encode('utf-8')
ts = _now_ns()
content_hash = _blake2b(state)
sign_input = (
cid_bytes +
aid_bytes +
struct.pack('>QQ', step, ts) +
content_hash
)
sig = _sign(self.signing_key, sign_input)
hdr = struct.pack(
CKPT_HDR_FMT,
CKPT_MAGIC,
VERSION,
FLAGS,
len(cid_bytes),
len(aid_bytes),
len(pid_bytes),
len(state),
step,
ts,
content_hash,
sig
)
with open(self.path, 'ab') as f:
f.write(hdr)
f.write(cid_bytes)
f.write(aid_bytes)
f.write(pid_bytes)
f.write(state)
return CheckpointRecord(
checkpoint_id=checkpoint_id,
agent_id=agent_id,
prev_id=prev_id,
state=state,
step=step,
timestamp_ns=ts,
content_hash=content_hash,
signature=sig
)
def scan(self) -> Iterator[CheckpointRecord]:
if not self.path.exists():
return
with open(self.path, 'rb') as f:
while True:
hdr_bytes = f.read(CKPT_HDR_SIZE)
if not hdr_bytes:
break
if len(hdr_bytes) < CKPT_HDR_SIZE:
break
(magic, ver, flags, cid_len, aid_len, pid_len,
slen, step, ts, content_hash, sig) = struct.unpack(
CKPT_HDR_FMT, hdr_bytes
)
if magic != CKPT_MAGIC:
break
cid_bytes = f.read(cid_len)
aid_bytes = f.read(aid_len)
pid_bytes = f.read(pid_len)
state = f.read(slen)
if len(state) < slen:
break
yield CheckpointRecord(
checkpoint_id=cid_bytes.decode('utf-8', errors='replace'),
agent_id=aid_bytes.decode('utf-8', errors='replace'),
prev_id=pid_bytes.decode('utf-8', errors='replace'),
state=state,
step=step,
timestamp_ns=ts,
content_hash=content_hash,
signature=sig
)
def get_by_id(self, checkpoint_id: str) -> CheckpointRecord | None:
for rec in self.scan():
if rec.checkpoint_id == checkpoint_id:
return rec
return None
def get_by_step(self, step: int) -> CheckpointRecord | None:
for rec in self.scan():
if rec.step == step:
return rec
return None
def get_latest(self) -> CheckpointRecord | None:
last = None
for rec in self.scan():
last = rec
return last
def list_ids(self) -> list[tuple[str, int]]:
"""Returns list of (checkpoint_id, step) pairs."""
return [(rec.checkpoint_id, rec.step) for rec in self.scan()]
def verify_chain(self) -> tuple[bool, int]:
count = 0
for rec in self.scan():
expected = _blake2b(rec.state)
if rec.content_hash != expected:
return False, count
count += 1
return True, count
|