rustio-admin-macros 0.13.0

Proc-macros for rustio-admin (re-exported from the rustio-admin crate).
Documentation

Authentication, sessions, audit trails, and recovery are designed as one system, not assembled as separate parts.

Postgres only. No build step. Single binary deployment.

30-second example

An admin surface is one derive, one impl, one register call.

#[derive(RustioAdmin)]
pub struct Post { pub id: i64, pub title: String, /* … */ }

impl Model      for Post { /* TABLE, COLUMNS, from_row, insert_values */ }
impl ModelAdmin for Post {}                  // accept every default

let admin  = Admin::new().model::<Post>();
let router = register_admin_routes(Router::new(), admin, db, templates);
Server::new(router, addr).run().await?;

A model that wants more control fills in the ModelAdmin body:

impl ModelAdmin for Post {
    fn list_display()  -> &'static [&'static str] { &["title", "published", "created_at"] }
    fn list_filter()   -> &'static [&'static str] { &["published"] }
    fn search_fields() -> &'static [&'static str] { &["title", "body"] }
    fn ordering()      -> &'static [&'static str] { &["-created_at"] }
}

Why RustIO exists

Three observations shape the framework.

CRUD is the surface

The weight of production administrative work sits underneath — authority transitions, session lifecycle, recovery, audit chains.

RustIO treats these as first-class concerns.

Doctrine before implementation

Authentication, recovery, session invalidation, and audit behaviour are governed by checked-in contract documents.

Pull requests are reviewed against the doctrine, not only against the implementation diff.

Operational clarity over flexibility

The framework targets one database, ships one stylesheet, and requires no build step.

Authority, sessions, recovery, and audit receive the engineering attention. The rest stays intentionally simple.

The framework surface stays intentionally narrow so the security-sensitive paths remain reviewable.

Core principles

The invariants the framework refuses to break.

Doctrine 22 Session invalidation has a single writer.

Uniform outward responses Recovery and login surfaces collapse every failure mode into a single response shape.

Audit-by-default Every authority mutation emits a typed AuditEvent.

No plaintext at rest Argon2id for passwords. SHA-256 for session and reset tokens.

What's in the box

The surface is grouped into five concerns.

Admin surface

  • #[derive(RustioAdmin)] on a struct generates list, create, edit, and delete pages.
  • impl ModelAdmin overrides defaults — list_display, list_filter, search_fields, ordering, list_per_page.
  • Per-model RBAC over a five-tier role hierarchy.

Identity and sessions

  • DB-backed sessions with Argon2id passwords.
  • Hashed-at-rest session tokens.
  • Centralised invalidation through auth::sessions::invalidate_sessions.

Recovery

  • Self-service forgot and reset.
  • Admin-driven password reset, lock, unlock, and revoke.
  • Auto-throttle on failed logins.
  • Re-auth wall for destructive admin actions.

Audit and observability

  • Typed AuditEvent with stable string identifiers.
  • Per-request correlation IDs.
  • Redaction helpers for tokens and passwords.

Operational

  • Postgres-only. Hyper, sqlx, and minijinja under the hood.
  • Single binary deploy. No build step. One stylesheet.
  • Project templates and CSS embedded at compile time.

Most projects use a subset. The framework does not require adopting all of it.

Install

The library and the CLI ship as separate crates.

[dependencies]
rustio-admin = "0.12.0"
tokio  = { version = "1", features = ["macros", "rt-multi-thread"] }
chrono = { version = "0.4", features = ["serde"] }

cargo install rustio-admin-cli      # provides the `rustio` binary

Documentation

Full documentation index: docs/README.md.

Path Contents
docs/ Guides, doctrine, architecture overview.
docs/design/ Long-form design contracts — one file per security-sensitive subsystem.
docs/public-api.md Enumerated public API surface (generated; descriptive, not normative).
docs/archive/ Historical and superseded planning material.

Reading paths

Where to start depends on the work.

New to the framework → 30-second example above → docs/getting-started.md → DESIGN_SYSTEM.md

Working on authentication or recovery → DESIGN_RECOVERY.md → DESIGN_R2_ORGANISATIONAL.md

Auditing authority boundaries → DESIGN_AUDIT.md → DESIGN_SESSIONS.md

Building on the published crate → Install above → docs/modeladmin.md → examples/library-circulation/

Understanding scope and design history → docs/architecture.md → rustio-admin-strategic-reset-plan.md → CHANGELOG.md

Doctrine documents

Security-sensitive behaviour is governed by explicit contract documents reviewed alongside the code.

DESIGN_SYSTEM.md

Visual, token, and branding contract.

DESIGN_SESSIONS.md

Session lifecycle, trust escalation, and Doctrine 22 — the single-writer invariant on revoked_at.

DESIGN_AUDIT.md

Typed audit events, correlation-id chains, and the required middleware ordering.

DESIGN_RECOVERY.md

Self-service password recovery (R1, ships in 0.5.0).

DESIGN_R2_ORGANISATIONAL.md

Admin-driven recovery, auto-throttle, re-auth wall (R2, ships in 0.6.0).

Each document is the source of truth for its surface.

Workspace layout

Three crates ship together. The split keeps proc-macros and CLI compilation off the project's hot path.

Crate Purpose
rustio-admin The library. Re-exports the macros.
rustio-admin-macros Proc-macros (re-exported from rustio-admin).
rustio-admin-cli The rustio binary — startproject, startapp, migrate, user, group, perm, doctor. 
cargo build --workspace
cargo test  --workspace

Non-goals

RustIO is intentionally narrow in scope.

  • Not a general-purpose web framework.
  • Not an ORM. The Model trait is a thin sqlx shim.
  • Not a content management system.
  • Not AI-augmented.
  • Not multi-database. Postgres only, by design.
  • Not schema-contract-driven.

License

MIT — see LICENSE.