Skip to main content

Module pairing

Module pairing 

Source
Expand description

Pairing protocol facade — re-exports from auths-pairing-protocol plus transport-specific QR rendering and error types.

Modules§

types

Structs§

Base64UrlEncoded
A base64url-encoded (no padding) byte string.
CreateSessionRequest
Request to create a new pairing session.
CreateSessionResponse
Response to session creation.
GetConfirmationResponse
Response when polling for confirmation.
GetSessionResponse
Response when getting session status.
PairingResponse
A response to a pairing request from the responding device.
PairingSession
Ephemeral keypair for a pairing session.
PairingToken
A pairing token for initiating cross-device identity linking.
QrOptions
QR code rendering options.
SubmitConfirmationRequest
Request to submit a SAS confirmation (or abort).
SubmitResponseRequest
Request to submit a pairing response.
SuccessResponse
Response for successful operations.

Enums§

PairingError
Errors that can occur during the pairing protocol.
ProtocolError
Protocol-level errors for the pairing exchange.
SessionStatus
Session status.

Functions§

format_pairing_qr
Format a pairing QR code with header text for terminal display.
normalize_short_code
Normalize a short code: uppercase, strip spaces/dashes.
render_qr
Render a pairing token as a QR code string for terminal display.
render_qr_from_data
Render arbitrary data as a QR code string for terminal display.