Enum SendAuthType 

pub enum SendAuthType {
    None,
    Password {
        password: String,
    },
    HashedPassword {
        key_b64: String,
    },
    Emails {
        emails: Vec<String>,
    },
}

Type-safe authentication method for a Send, including the authentication data. This ensures that password and email authentication are mutually exclusive.

Variants

None

No authentication required

Password

Password-based authentication. The SDK derives the wire-format keyB64 via PBKDF2 over the send key.

Fields

password: String

The plaintext password the recipient will enter to access the Send.

HashedPassword

Pre-derived password. The caller has already run PBKDF2 client-side and supplies the resulting base64-encoded hash; the SDK forwards it verbatim. Use this when the hashing happens outside the SDK (e.g. the legacy TypeScript clients that derive in SendService.encrypt). For new code that holds a plaintext password, use Password { ... } and let the SDK do the derivation.

Fields

key_b64: String

Base64-encoded PBKDF2 output (keyB64) ready for the wire.

Emails

Email-based OTP authentication

Fields

emails: Vec<String>

List of email addresses that will receive OTP codes

Implementations

impl SendAuthType

pub fn from_plaintext_password(password: String) -> Self

Construct a Password variant from a plaintext password. The SDK will run PBKDF2 during encryption.

pub fn from_hashed_password(key_b64: String) -> Self

Construct a HashedPassword variant from an already-derived keyB64. The SDK forwards it verbatim — no further derivation. Misuse (passing plaintext here) produces an unsatisfiable server-side hash.

pub fn auth_type(&self) -> AuthType

Returns the AuthType discriminant for this authentication method

pub(crate) fn validate(&self) -> Result<(), EmptyEmailListError>

Validates that the auth configuration is valid. Returns an error if Emails is used with an empty list.

pub(crate) fn auth_data(&self, k: &[u8]) -> (Option<String>, Option<String>)

Returns (password, emails) for the wire request. For Password, runs PBKDF2 over the plaintext using k as the salt. For HashedPassword, forwards the supplied keyB64 verbatim — k is unused on that branch.

Trait Implementations

impl Clone for SendAuthType

fn clone(&self) -> SendAuthType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for SendAuthType

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for SendAuthType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SendAuthType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for SendAuthType

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<SendAuthType> for JsValue

where SendAuthType: Serialize,

fn from(value: SendAuthType) -> Self

Converts to this type from the input type.

impl FromWasmAbi for SendAuthType

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for &SendAuthType

where SendAuthType: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for SendAuthType

where SendAuthType: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<UT> Lift<UT> for SendAuthType

type FfiType = <SendAuthType as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for SendAuthType

type LiftType = SendAuthType

impl<UT> LiftReturn<UT> for SendAuthType

type ReturnType = <SendAuthType as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for SendAuthType

type FfiType = <SendAuthType as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for SendAuthType

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SendAuthType

type ReturnType = <SendAuthType as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for SendAuthType

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for SendAuthType

where SendAuthType: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for SendAuthType

fn eq(&self, other: &SendAuthType) -> 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 RefFromWasmAbi for SendAuthType

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<SendAuthType>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl Serialize for SendAuthType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for SendAuthType

const DECL: &'static str = "/**\n * Type-safe authentication method for a Send, including the authentication data.\n * This ensures that password and email authentication are mutually exclusive.\n */\nexport type SendAuthType = { type: \"none\" } | { type: \"password\"; password: string } | { type: \"hashedPassword\"; keyB64: string } | { type: \"emails\"; emails: string[] };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl<UT> TypeId<UT> for SendAuthType

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for SendAuthType

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for SendAuthType

where SendAuthType: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for SendAuthType

fn describe()

impl WasmDescribeVector for SendAuthType

fn describe_vector()

impl Eq for SendAuthType

impl StructuralPartialEq for SendAuthType