ol.trixnity.key

Encryption-key state, backup state, and trust-level queries.

Upstream Mapping

This namespace maps to Trixnity’s KeyService and KeyBackupService.

The public wrappers here cover:

  • current and flow-based backup bootstrap state

  • cross-signing bootstrap

  • current and flow-based backup-version observation

  • trust-level queries for users, devices, and timeline events

  • device-key and cross-signing-key lookup

Use ol.trixnity.verification for active verification workflows and ol.trixnity.room when you need room timeline events to pair with trust-level checks.

current-bootstrap-running

(current-bootstrap-running client)

Returns whether cross-signing bootstrap is currently running.

source

bootstrap-running

(bootstrap-running client)

Returns a Missionary flow of cross-signing bootstrap state.

source

bootstrap-cross-signing!

(bootstrap-cross-signing! client)
(bootstrap-cross-signing! client opts)

Bootstraps cross-signing for the current Matrix account.

Returns a Missionary task. The task resolves to a normalized map with:

  • ::mx/kind — "success", "uia-required", or "uia-error"

  • ::mx/recovery-key — the recovery key generated by Trixnity

  • ::mx/uia — a UIA snapshot with completed stages, flows, session, and error details

By default this calls Trixnity’s KeyService.bootstrapCrossSigning(). If opts includes ::mx/password, the bridge attempts to complete a password UIA step before returning. ::mx/user-id can override the password UIA user identifier; otherwise the current client’s Matrix user id is used.

"uia-required" and "uia-error" results do not expose Trixnity UIA objects. Inspect ::mx/uia to decide which public UIA flow or error remains.

Persist or display ::mx/recovery-key securely; it is the user’s recovery key material for the new bootstrap.

Be aware that upstream cross-signing bootstrap can replace existing cross-signing and key-backup state for the account.

source

bootstrap-cross-signing-from-passphrase!

(bootstrap-cross-signing-from-passphrase! client passphrase)
(bootstrap-cross-signing-from-passphrase! client passphrase opts)

Bootstraps cross-signing with a secret-storage passphrase.

Returns the same normalized Missionary task result as bootstrap-cross-signing!, but calls Trixnity’s KeyService.bootstrapCrossSigningFromPassphrase(passphrase). passphrase configures the generated secret storage; use ::mx/password in opts for password-based UIA completion.

Be aware that upstream cross-signing bootstrap can replace existing cross-signing and key-backup state for the account.

source

current-backup-version

(current-backup-version client)

Returns the current active room-key-backup version, or nil when unavailable.

source

backup-version

(backup-version client)

Returns a Missionary flow of the active room-key-backup version.

source

get-trust-level

(get-trust-level client user-id)
(get-trust-level client user-id-or-room-id device-id-or-event-id)

Returns a Missionary flow of trust information.

With two arguments, user-id resolves to the trust level of that user.

With three arguments, the meaning depends on the first id:

  • a @user:server value resolves device trust for device-id

  • a !room:server value resolves the trust level for the device that sent the timeline event-id

source

get-device-keys

(get-device-keys client user-id)

Returns a Missionary flow of device keys for user-id.

source

get-cross-signing-keys

(get-cross-signing-keys client user-id)

Returns a Missionary flow of cross-signing keys for user-id.

source