Struct PasskeyAuthenticator

pub struct PasskeyAuthenticator { /* private fields */ }

A passkey authenticator.

BCS

The BCS serialized form for this type is defined by the following ABNF:

passkey-bcs = bytes               ; where the contents of the bytes are
                                  ; defined by <passkey>
passkey     = passkey-flag
              bytes               ; passkey authenticator data
              client-data-json    ; valid json
              simple-signature    ; required to be a secp256r1 signature

client-data-json = string ; valid json

See CollectedClientData for the required json-schema for the client-data-json rule. In addition, Sui currently requires that the CollectedClientData.type field is required to be webauthn.get.

Note: Due to historical reasons, signatures are serialized slightly different from the majority of the types in Sui. In particular if a signature is ever embedded in another structure it generally is serialized as bytes meaning it has a length prefix that defines the length of the completely serialized signature.

Implementations

impl PasskeyAuthenticator

pub fn new( authenticator_data: Vec<u8>, client_data_json: String, signature: SimpleSignature, ) -> Option<Self>

Available on crate feature serde only.

impl PasskeyAuthenticator

pub fn authenticator_data(&self) -> &[u8]

Opaque authenticator data for this passkey signature.

See Authenticator Data for more information on this field.

pub fn client_data_json(&self) -> &str

Structured, unparsed, JSON for this passkey signature.

See CollectedClientData for more information on this field.

pub fn challenge(&self) -> &[u8]

The parsed challenge message for this passkey signature.

This is parsed by decoding the base64url data from the client_data_json.challenge field.

pub fn signature(&self) -> SimpleSignature

The passkey signature.

Trait Implementations

impl Arbitrary for PasskeyAuthenticator

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<PasskeyAuthenticator>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for PasskeyAuthenticator

fn clone(&self) -> PasskeyAuthenticator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PasskeyAuthenticator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PasskeyAuthenticator

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PasskeyAuthenticator

fn eq(&self, other: &PasskeyAuthenticator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PasskeyAuthenticator

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PasskeyAuthenticator

impl StructuralPartialEq for PasskeyAuthenticator