API Reference Ithibati v#0.1.0

Copy Markdown View Source

Modules

Passkey authentication: the account row, its WebAuthn credentials, its recovery codes and the sessions it is signed in with.

The record that an instance has been set up, and by whom.

What Postgres says about the tables an application owns.

The handful of things the application decides and tells Ithibati.

What an application has to get right before Ithibati works, asked one question at a time.

The credential half of creating an account, as a fragment the application composes into its own transaction.

Setting a deployment up: the first account, and the record that it happened.

Opening an invitation, and accepting one.

The WebAuthn ceremony, both halves: enrolling a browser's credential as an account's passkey, and proving possession of one afterwards. It also covers what an account can do with the credentials it holds: list them, rename one, revoke one.

Single-use codes, for the day a passkey is gone.

The revocable half of being signed in: what an account is issued once it has proved who it is.

Creates Ithibati's tables, as code rather than as a file to copy.

One single-use code, stored as a hash, for the day a passkey is gone.

What an identifier is, for every schema Ithibati injects one into.

What Ithibati puts on an invitation, and what an invitation owes Ithibati.

What Ithibati adds to the account schema an application already owns.

One signed-in session. The cookie carries the secret and this row carries only its sha256, so the table is not a set of usable sessions. The row is what makes a sign-in revocable: deleting it ends the session for new requests and new mounts.

One WebAuthn credential: the public half of a passkey, and the label a person recognises it by.

Who is signed in, on a connection and in a LiveView, from one place.

The callbacks an application implements, so the ceremony can ask it what to decide.

The colocated route for Ithibati's JavaScript.

The two ceremonies and the recovery route, five actions, as JSON.

The five routes the ceremonies need, wired in one call.

Mix Tasks

Prints what Ithibati.Doctor answers, and exits non-zero when something is wrong.