slither 0.3.0

//! §17.1 — the per-remote-static greatest-initiation-timestamp guard.
//!
//! One entry per peer static, holding the greatest initiation timestamp
//! (§5.3) we have ever **recorded** for it. An initiation strictly greater
//! than the entry passes; anything else is a replay. Where we have recorded
//! nothing the check passes vacuously.
//!
//! # Every write site is post-`ss`
//!
//! §17.1 has four write sites and all four sit **after** the proving `ss`,
//! so **only a key-holder can write a guard entry**, and all four are now
//! implemented: `authenticate()` on the staged path — which is also
//! §6.4's **re-homed** candidate's check-and-record, since `accept()`'s
//! LIVE arm (`staged.rs`) admits the replacement from that record paired
//! with §17.4's replacement basis, rather than writing the guard a second
//! time — §6.6 step 4's tie-break admit, and §6.7's winner-side record (by
//! either of §6.6's two routes).
//! `[corrected 2026/08/18 — ruling 264]`
//! [`GuardEntry::exempt_until`] was shaped for the last two from the start,
//! and ruling 91 spent it as predicted — one added call
//! ([`TimestampGuard::extend_exemption`]), no migration.
//!
//! **The initiator path never touches this.** §17.1: for a static we only
//! ever dialled "we hold no entry at all — every §17.1 write site is a
//! post-`ss` read of an *inbound* msg1, and a `connect()` completed by msg2
//! writes nothing".
//!
//! # The write is provisional until `accept()`
//!
//! Mitigation **(i) no-orphan-on-reject**: *"a static authenticated and
//! then rejected without ever being accepted writes no orphan (its record
//! drops with the chain; a pre-existing entry reverts)"*, and the revert
//! applies "whether the rejection is a dropped chain or an `accept()` that
//! returns `AcceptError::Stale`". So `authenticate()` hands the chain a
//! [`GuardUndo`], and every path that ends the chain without accepting runs
//! it. This is the single most consequential line in the guard: the failure
//! is silent, permanent, and blocks a real peer's next genuine initiation.
//!
//! # Pinning
//!
//! An entry is pinned — never evicted, never aged — while a live
//! connection, an in-flight outbound pending, **or a staged mid-state**
//! exists for its static. A mid-state exists from `read_identity()`, when
//! the static is still merely *claimed*, which §17.1 addresses directly: a
//! pin **never creates an entry**, it only "flips a bit on an entry a
//! key-holder already wrote". So [`TimestampGuard::pin`] on an absent key
//! is a no-op, not an insert — that is what keeps the bounded exception to
//! §6.1's nothing-durable rule bounded.
//!
//! `pins` is a **count**, not a flag: a static can hold a mid-state and an
//! outbound pending at once (that is §5.4's PENDING row), and a flag would
//! lose the second pin on the first release, unpinning a live entry.
//!
//! **[RATIFIED 2026/08/15 — ruling 77]** Pins come in two kinds
//! ([`PinKind`]). Both bar eviction; only a **key-holder** release starts
//! the aging clock below. A pin taken at `read_identity()` is a *claimed*
//! static's and proves nothing — so an unauthenticated party naming a
//! static that already holds an entry must not be able to move that
//! entry's timer.
//!
//! # The orphan clock starts at release (**ruling 73**)
//!
//! An entry ages from the instant its **last pin is released**, never from
//! its last admission: §17.1 defines an orphan as a *dead-connection*
//! entry, and an entry cannot age as an orphan before it is one. The two
//! clocks are kept apart on the entry — [`GuardEntry::last_admitted`] is
//! mitigation (iii)'s LRU recency and stays admission-only,
//! [`GuardEntry::orphaned_at`] is the aging clock — because collapsing them
//! deletes the guard for the longest-lived connections at exactly the
//! moment a captured initiation becomes replayable.

use std::collections::HashMap;
use std::time::Instant;

use crate::constants;
use crate::core::Timestamp;

/// What a §17.1 pin proves about whoever holds it. **Ruling 77.**
///
/// Both kinds bar eviction — §17.1's bullet is unchanged — but only a
/// [`KeyHolder`](PinKind::KeyHolder) release starts ruling 73's orphan
/// clock. Reaching [`Claimed`](PinKind::Claimed) costs 1 DH and proves
/// **nothing**: §6.1 is explicit that the claimed static is
/// attacker-choosable. So without this split anyone able to send a
/// mac1-valid msg1 naming a static that already holds an entry could
/// restart that entry's clock at will and defer mitigation (ii)
/// indefinitely. §17.1 states the principle: this is §6.1's "nothing
/// durable may be keyed on the claimed static" reaching one step further —
/// not merely no new durable state, but **no control over the lifetime of
/// existing state**.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum PinKind {
    /// A staged chain at §6.1's stage 1. Attacker-choosable.
    Claimed,
    /// A live connection, an in-flight outbound pending, or a `Proven`
    /// chain — every one of which took the peer's key to reach.
    KeyHolder,
}

/// One static's guard state.
#[derive(Debug, Clone)]
pub(crate) struct GuardEntry {
    /// The greatest initiation timestamp recorded for this static.
    ///
    /// `None` means **an entry that exists only to hold a pin**: its record
    /// was reverted by mitigation (i) while something else still pinned it,
    /// so the entry cannot be removed but must not keep the value. §17.1
    /// says the record "drops with the chain", not merely that an unpinned
    /// entry is deleted — so this case has to be representable, or a
    /// second pin turns authenticate-then-drop back into an orphan mint.
    pub(crate) greatest: Option<Timestamp>,
    /// Live connections + in-flight pendings + staged mid-states.
    ///
    /// **All** pins, of either [`PinKind`]: this is the count §17.1's
    /// "never evicted, never aged while pinned" rests on, and ruling 77
    /// left it alone.
    pub(crate) pins: u32,
    /// The subset of [`pins`](GuardEntry::pins) that are
    /// [`PinKind::KeyHolder`]. **Ruling 77.**
    ///
    /// The orphan clock is stamped when *this* reaches zero, not when
    /// `pins` does. A lingering `Claimed` pin therefore still suspends
    /// aging — [`age_deadline`](GuardEntry::age_deadline) tests `pins` —
    /// but the instant the window will be measured from is already fixed,
    /// and the `Claimed` holder cannot move it.
    pub(crate) keyholder_pins: u32,
    /// §6.6/§6.7's `HANDSHAKE_GIVEUP` extension past the connection's
    /// death, written by [`extend_exemption`](TimestampGuard::extend_exemption)
    /// at the instant the entry's last §17.1 pin is released — which is the
    /// instant §17.1 dates the window from, for both of the cases it names.
    pub(crate) exempt_until: Option<Instant>,
    /// LRU recency. **Admission only** (mitigation (iii)): it refreshes on
    /// a successful post-`ss` record and never on a failed check, which is
    /// what keeps the write path key-holder-only.
    ///
    /// **[RATIFIED 2026/08/15 — ruling 73]** This is the *recency* key and
    /// nothing else. It used to double as the aging clock; it no longer
    /// does. Mitigation (iii) is untouched — only
    /// [`orphaned_at`](GuardEntry::orphaned_at) moved.
    pub(crate) last_admitted: Instant,
    /// When this entry became an **orphan** — the instant its last
    /// **key-holder** pin was released ([`PinKind`], ruling 77). `None`
    /// while a key-holder pin is held.
    /// **[RATIFIED 2026/08/15 — rulings 73 and 77]**
    ///
    /// §17.1 defines an orphan as a *dead-connection* entry, so an entry
    /// cannot age **as an orphan** before it is one. Aging from
    /// [`last_admitted`](GuardEntry::last_admitted) instead deleted the
    /// guard for exactly the connections that held it longest: a session
    /// outliving `TS_GUARD_ORPHAN_TTL` carries `last_admitted` frozen at
    /// accept time, so at retirement the entry is *already* past its
    /// deadline and dies at the next sweep with **no orphan window at
    /// all** — precisely when a captured initiation becomes replayable.
    ///
    /// # It is the real instant
    ///
    /// **[RATIFIED 2026/08/15 — ruling 80]** §16.4 now passes `now` to
    /// `handle_connection_event` and `reject`, the two verbs that release a
    /// pin. Both are *mutating* calls, so the invariant §16.4 states — a
    /// `now` on every mutating call, and the cores never read a clock —
    /// always required it; the block was ratified carrying an invariant it
    /// did not satisfy, and the two verbs that had to know the time were
    /// the two not given it. So this stamp is the release instant, with no
    /// watermark, no approximation and no floor to correct one.
    pub(crate) orphaned_at: Option<Instant>,
}

impl GuardEntry {
    fn pinned(&self, now: Instant) -> bool {
        self.pins > 0 || self.exempt_until.is_some_and(|until| until > now)
    }

    /// When this entry becomes eligible for aging out, or `None` while a
    /// live pin holds it.
    ///
    /// The test is on **`pins`, of either [`PinKind`]** — ruling 77 narrowed
    /// which release *starts* the clock, not which pin suspends it. §17.1's
    /// "never evicted, never aged" bullet, which a staged mid-state is
    /// named in, is unchanged.
    ///
    /// The `?` on `orphaned_at` is a belt-and-braces `None`: an entry with
    /// no key-holder pin always carries a stamp. Answering `None` — never
    /// swept, never announced — is the safe direction if that invariant is
    /// ever broken, where a fabricated instant would not be.
    ///
    /// Computed without a `now`, so §16.5's min-deadline scan needs no
    /// clock: a `HANDSHAKE_GIVEUP` exemption (§6.6/§6.7, slice 7) simply
    /// pushes the instant out rather than being tested against the present.
    ///
    /// **The clock runs from `orphaned_at`, not `last_admitted`** (ruling
    /// 73). This is the single source of truth for the aging decision —
    /// [`age_orphans`](TimestampGuard::age_orphans) sweeps by it too, so the
    /// announced deadline and the sweep that honours it cannot drift.
    fn age_deadline(&self) -> Option<Instant> {
        if self.pins > 0 {
            return None;
        }
        let base = self.orphaned_at? + constants::TS_GUARD_ORPHAN_TTL;
        Some(match self.exempt_until {
            Some(until) if until > base => until,
            _ => base,
        })
    }
}

/// The §17.1 pin a staged chain holds, and what it proves. **Ruling 77.**
///
/// The kind is carried rather than re-derived at release, because a chain
/// that failed mid-verb is [`Poisoned`](super::staged::ChainState::Poisoned)
/// and no longer says what stage it reached. Re-deriving would misclassify
/// exactly the failure paths, and a `KeyHolder` release misclassified as
/// `Claimed` leaves `keyholder_pins` stuck above zero — an entry that never
/// stamps, and so never ages.
#[derive(Debug, Clone)]
pub(crate) struct ChainPin {
    /// The static this chain pins.
    pub(crate) key: Vec<u8>,
    /// What the pin proves, as of now. Upgraded from
    /// [`PinKind::Claimed`] to [`PinKind::KeyHolder`] when the chain's
    /// `ss` lands (`authenticate()`).
    pub(crate) kind: PinKind,
}

/// What `authenticate()` must be able to undo. §17.1 mitigation (i).
///
/// `previous` is `None` when no entry existed before the write, in which
/// case the revert removes the entry outright.
#[derive(Debug, Clone)]
pub(crate) struct GuardUndo {
    key: Vec<u8>,
    /// Outer `None` = no entry existed before the record. Inner `None` =
    /// an entry existed holding no record (a pin-only entry).
    previous: Option<(Option<Timestamp>, Instant)>,
}

/// §17.1's guard.
#[derive(Debug, Default)]
pub(crate) struct TimestampGuard {
    entries: HashMap<Vec<u8>, GuardEntry>,
}

impl TimestampGuard {
    /// The recorded greatest timestamp for a static, if any.
    pub(crate) fn greatest(&self, key: &[u8]) -> Option<Timestamp> {
        self.entries.get(key).and_then(|e| e.greatest)
    }

    /// The live pin count for a static: connections + pendings +
    /// mid-states. `0` for an absent entry.
    pub(crate) fn pins(&self, key: &[u8]) -> u32 {
        self.entries.get(key).map_or(0, |e| e.pins)
    }

    /// Whether `candidate` would pass — **strictly** greater, vacuously
    /// true where nothing is recorded.
    pub(crate) fn admits(&self, key: &[u8], candidate: Timestamp) -> bool {
        match self.entries.get(key) {
            Some(entry) => entry.greatest.is_none_or(|g| candidate > g),
            None => true,
        }
    }

    /// Record a candidate that [`admits`](Self::admits) accepted, returning
    /// the undo the chain must carry until `accept()` makes it permanent.
    ///
    /// Refreshes LRU recency, because this is a *successful* record.
    pub(crate) fn record(&mut self, key: &[u8], candidate: Timestamp, now: Instant) -> GuardUndo {
        let previous = self.entries.get(key).map(|e| (e.greatest, e.last_admitted));
        match self.entries.get_mut(key) {
            Some(entry) => {
                entry.greatest = Some(candidate);
                entry.last_admitted = now;
            }
            None => {
                self.entries.insert(
                    key.to_vec(),
                    GuardEntry {
                        greatest: Some(candidate),
                        pins: 0,
                        keyholder_pins: 0,
                        exempt_until: None,
                        last_admitted: now,
                        // Born unpinned, so it is an orphan from this
                        // instant (ruling 73).
                        orphaned_at: Some(now),
                    },
                );
            }
        }
        self.evict_if_over_cap(now);
        GuardUndo {
            key: key.to_vec(),
            previous,
        }
    }

    /// Undo a provisional record. §17.1 mitigation (i).
    ///
    /// A pre-existing entry is restored — **greatest and recency both**,
    /// since the recency refresh was part of the record being undone. An
    /// entry the record created is removed, unless something has pinned it
    /// meanwhile, in which case only the value is rolled back to nothing
    /// recordable and the entry is left for its pin to release.
    pub(crate) fn revert(&mut self, undo: GuardUndo) {
        match undo.previous {
            Some((greatest, last_admitted)) => {
                if let Some(entry) = self.entries.get_mut(&undo.key) {
                    entry.greatest = greatest;
                    entry.last_admitted = last_admitted;
                }
            }
            None => {
                let still_pinned = self
                    .entries
                    .get(&undo.key)
                    .is_some_and(|entry| entry.pins > 0);
                if still_pinned {
                    // The entry cannot be removed — something else pins it —
                    // but §17.1's "its record drops with the chain" is about
                    // the RECORD, so the value goes even though the entry
                    // stays. Without this, a second pin (another chain for
                    // the same static, or a concurrent dial) makes the
                    // authenticate-then-drop flood mint orphans after all,
                    // which is the exact attack mitigation (i) forbids.
                    if let Some(entry) = self.entries.get_mut(&undo.key) {
                        entry.greatest = None;
                    }
                } else {
                    self.entries.remove(&undo.key);
                }
            }
        }
    }

    /// Take a pin. **Never creates an entry** (§17.1).
    ///
    /// A [`PinKind::KeyHolder`] pin **clears the orphan clock** (ruling
    /// 73): the entry is not an orphan while a key-holder holds it, so the
    /// window will be measured from the release still to come.
    ///
    /// A [`PinKind::Claimed`] pin leaves the stamp exactly where it was
    /// (ruling 77). It still suspends aging, because
    /// [`GuardEntry::age_deadline`] tests the total; what it cannot do is
    /// move the instant the window runs from.
    pub(crate) fn pin(&mut self, key: &[u8], kind: PinKind) -> bool {
        match self.entries.get_mut(key) {
            Some(entry) => {
                entry.pins = entry.pins.saturating_add(1);
                if kind == PinKind::KeyHolder {
                    entry.keyholder_pins = entry.keyholder_pins.saturating_add(1);
                    entry.orphaned_at = None;
                }
                true
            }
            None => false,
        }
    }

    /// Upgrade a [`PinKind::Claimed`] pin to [`PinKind::KeyHolder`], where
    /// the chain holding it has since proven possession. **Ruling 77.**
    ///
    /// `read_identity()` pins at stage 1, when the static is merely
    /// *claimed*. When `authenticate()`'s `ss` lands the chain becomes
    /// `Proven` and that same pin is a key-holder's — §17.1 names a
    /// `Proven` chain alongside a live connection. Without this the entry
    /// would keep a stamp the key-holder has superseded.
    ///
    /// Guarded against over-counting: a chain proves once, and
    /// `authenticate()` on an already-`Proven` chain returns before
    /// reaching here.
    pub(crate) fn promote_pin(&mut self, key: &[u8]) {
        let Some(entry) = self.entries.get_mut(key) else {
            return;
        };
        if entry.keyholder_pins >= entry.pins {
            debug_assert!(false, "promoting a pin that was never taken");
            return;
        }
        entry.keyholder_pins += 1;
        entry.orphaned_at = None;
    }

    /// Release a pin taken by [`pin`](Self::pin).
    ///
    /// **Rulings 73 and 77: this is where the orphan clock starts** — but
    /// only when the pin being released is a
    /// [`KeyHolder`](PinKind::KeyHolder) one and it was the last of them. A
    /// [`Claimed`](PinKind::Claimed) release leaves the stamp untouched, so
    /// an unauthenticated party naming someone else's static cannot move
    /// the timer.
    ///
    /// **[RATIFIED 2026/08/15 — ruling 80]** `now` is the release instant
    /// itself. Every verb that reaches this one carries a `now`, including
    /// `handle_connection_event` and `reject`, which §16.4 now passes it to
    /// precisely because ruling 73 made them stamp this field.
    pub(crate) fn unpin(&mut self, key: &[u8], kind: PinKind, now: Instant) {
        let Some(entry) = self.entries.get_mut(key) else {
            return;
        };
        entry.pins = entry.pins.saturating_sub(1);
        if kind == PinKind::KeyHolder {
            entry.keyholder_pins = entry.keyholder_pins.saturating_sub(1);
        }
        // A pin-only entry (record already reverted) has nothing left to
        // protect once its last pin goes, and leaving it would be an orphan
        // with no record — pure bookkeeping the LRU would then have to age.
        if entry.pins == 0 && entry.greatest.is_none() && entry.exempt_until.is_none() {
            self.entries.remove(key);
            return;
        }
        // Note the condition is on `keyholder_pins`, not `pins`: a lingering
        // `Claimed` chain still suspends aging, but the instant the window
        // runs from is fixed here, by the key-holder, and stays fixed.
        if kind == PinKind::KeyHolder && entry.keyholder_pins == 0 {
            entry.orphaned_at = Some(now);
        }
    }

    /// §17.1's `HANDSHAKE_GIVEUP` extension, dated by the caller.
    ///
    /// *"An entry written by the internal tie-break's admit step (§6.6 step
    /// 4) or by a **winner-side record** (§6.7, including §6.4's PENDING
    /// branch when we are the tie-break winner) stays exempt from orphan
    /// aging **and** LRU eviction for `HANDSHAKE_GIVEUP` (90 s) after the
    /// connection it belongs to dies."*
    ///
    /// Both halves of that come for free from
    /// [`exempt_until`](GuardEntry::exempt_until), which was shaped for
    /// this and is read by [`GuardEntry::age_deadline`] (aging) and by
    /// [`GuardEntry::pinned`] (the LRU). This is the call the module docs
    /// promised in place of a migration.
    ///
    /// # The instant is the caller's, and it is a floor
    ///
    /// The endpoint knows when the connection died; the guard does not,
    /// and §17.1 dates the window from that death. An existing exemption
    /// is extended, never shortened — a second tie-break write against a
    /// static whose first connection has already died must not pull the
    /// first one's window in.
    ///
    /// Absent entries are a no-op: like [`pin`](Self::pin), this **never
    /// creates an entry**. An extension exists to protect a record, and
    /// there is nothing to protect where no key-holder ever wrote one.
    pub(crate) fn extend_exemption(&mut self, key: &[u8], until: Instant) {
        let Some(entry) = self.entries.get_mut(key) else {
            return;
        };
        if entry.exempt_until.is_none_or(|current| until > current) {
            entry.exempt_until = Some(until);
        }
    }

    /// Mitigation (ii): age unpinned orphans out at
    /// [`TS_GUARD_ORPHAN_TTL`](constants::TS_GUARD_ORPHAN_TTL).
    ///
    /// The constant is ruling 70's — an alias of `INTRO_TTL`, so there is
    /// no second place for 15 s to be written down.
    ///
    /// Sweeps by [`age_deadline`](GuardEntry::age_deadline) — the same
    /// function §16.5's min-deadline scan announces, so the two cannot
    /// disagree. That shared reader is also what makes ruling 76's order
    /// benign: a give-up at step (1) releases a pin and stamps it at this
    /// same `now`, so the aging at step (3) reads a **fresh** window rather
    /// than an expired one.
    pub(crate) fn age_orphans(&mut self, now: Instant) {
        self.entries
            .retain(|_, entry| entry.age_deadline().is_none_or(|deadline| deadline > now));
    }

    /// When the next orphan ages out, if any is unpinned. §16.5's third
    /// deadline family.
    pub(crate) fn next_orphan_deadline(&self) -> Option<Instant> {
        self.entries
            .values()
            .filter_map(GuardEntry::age_deadline)
            .min()
    }

    /// Bounded LRU over the **unpinned** tier only.
    ///
    /// A linear scan, not a heap: the tier is capped at
    /// `TS_GUARD_ORPHAN_CAP` (1024) and eviction runs at most once per
    /// successful admission, which is a key-holder-gated event.
    fn evict_if_over_cap(&mut self, now: Instant) {
        while self
            .entries
            .values()
            .filter(|entry| !entry.pinned(now))
            .count()
            > constants::TS_GUARD_ORPHAN_CAP
        {
            let victim = self
                .entries
                .iter()
                .filter(|(_, entry)| !entry.pinned(now))
                .min_by(|a, b| {
                    a.1.last_admitted
                        .cmp(&b.1.last_admitted)
                        .then_with(|| a.0.cmp(b.0))
                })
                .map(|(key, _)| key.clone());
            match victim {
                Some(key) => {
                    self.entries.remove(&key);
                }
                None => break,
            }
        }
    }
}