Skip to main content

Module ipex

Module ipex 

Source
Expand description

auths ipex — IPEX (Issuance & Presentation EXchange) credential handover.

IPEX is KERI’s standard peer-to-peer handshake for moving an ACDC credential between two controllers: the discloser sends a grant exn carrying the credential, and the holder answers with an admit exn that references the grant’s SAID. It is the interoperable alternative to a bespoke presentation wire — a credential exchanged this way is one keripy/KERIA can ingest, and a grant a keripy peer sends is one auths can parse.

Two directions, mirroring the two roles in a disclosure:

  • auths ipex grant — discloser → holder: read a saidified ACDC, embed it in a /ipex/grant exn addressed to the recipient, and print the exn.
  • auths ipex admit — holder → discloser: read a peer’s grant exn, verify it (and the credential inside it), and print an /ipex/admit exn whose prior is the grant’s SAID.

The wire definitions (the exn records, their SAIDs, the embeds block) live in auths-keri::ipex and are byte-exact with keripy 1.3.4; this is a thin file-based CLI adapter over them. Signing the exn and putting it on a transport are the caller’s concern — this surface produces the canonical bytes to sign and send.

Structs§

AdmitArgs
auths ipex admit — accept a credential a peer granted.
GrantArgs
auths ipex grant — disclose a credential to a holder.
IpexCommand
Exchange an ACDC credential over IPEX (grant/admit), interoperable with keripy/KERIA.

Enums§

IpexAction
The two IPEX directions: grant a credential, or admit a received grant.