Enum InitUserCryptoMethod 

pub enum InitUserCryptoMethod {
    MasterPasswordUnlock {
        password: String,
        master_password_unlock: MasterPasswordUnlockData,
    },
    ClientManagedState {},
    DecryptedKey {
        decrypted_user_key: String,
    },
    Pin {
        pin: String,
        pin_protected_user_key: EncString,
    },
    PinEnvelope {
        pin: String,
        pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope,
    },
    AuthRequest {
        request_private_key: B64,
        method: AuthRequestMethod,
    },
    DeviceKey {
        device_key: String,
        protected_device_private_key: EncString,
        device_protected_user_key: UnsignedSharedKey,
    },
    KeyConnector {
        master_key: B64,
        user_key: EncString,
    },
    KeyConnectorUrl {
        url: String,
        key_connector_key_wrapped_user_key: EncString,
    },
}

The crypto method used to initialize the user cryptographic state.

Variants

MasterPasswordUnlock

Master Password Unlock

Fields

password: String

The user’s master password

master_password_unlock: MasterPasswordUnlockData

Contains the data needed to unlock with the master password

ClientManagedState

Read the user-key directly from client-managed state Note: In contrast to InitUserCryptoMethod::DecryptedKey, this does not update the state after initalizing

DecryptedKey

Never lock and/or biometric unlock

Fields

decrypted_user_key: String

The user’s decrypted encryption key, obtained using get_user_encryption_key

Pin

PIN

Fields

pin: String

The user’s PIN

pin_protected_user_key: EncString

The user’s symmetric crypto key, encrypted with the PIN. Use derive_pin_key to obtain this.

PinEnvelope

PIN Envelope

Fields

pin: String

The user’s PIN

pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope

The user’s symmetric crypto key, encrypted with the PIN-protected key envelope.

AuthRequest

Auth request

Fields

request_private_key: B64

Private Key generated by the crate::auth::new_auth_request.

method: AuthRequestMethod

The type of auth request

DeviceKey

Device Key

Fields

device_key: String

The device’s DeviceKey

protected_device_private_key: EncString

The Device Private Key

device_protected_user_key: UnsignedSharedKey

The user’s symmetric crypto key, encrypted with the Device Key.

KeyConnector

Key connector

Fields

master_key: B64

Base64 encoded master key, retrieved from the key connector.

user_key: EncString

The user’s encrypted symmetric crypto key

KeyConnectorUrl

In contrast to key-connector, this does all of the connection with key-connector in the sdk

Fields

url: String

The url to retrieve the key-connector-key from

key_connector_key_wrapped_user_key: EncString

The encrypted user key, encrypted with the key connector key retrieved from the url

Trait Implementations

impl<UT> ConvertError<UT> for InitUserCryptoMethod

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

impl Debug for InitUserCryptoMethod

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitUserCryptoMethod

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 InitUserCryptoMethod

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<InitUserCryptoMethod> for JsValue

where InitUserCryptoMethod: Serialize,

fn from(value: InitUserCryptoMethod) -> Self

Converts to this type from the input type.

impl FromWasmAbi for InitUserCryptoMethod

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 &InitUserCryptoMethod

where InitUserCryptoMethod: 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 InitUserCryptoMethod

where InitUserCryptoMethod: 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 InitUserCryptoMethod

type FfiType = <InitUserCryptoMethod 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 InitUserCryptoMethod

type LiftType = InitUserCryptoMethod

impl<UT> LiftReturn<UT> for InitUserCryptoMethod

type ReturnType = <InitUserCryptoMethod 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 InitUserCryptoMethod

type FfiType = <InitUserCryptoMethod 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 InitUserCryptoMethod

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for InitUserCryptoMethod

type ReturnType = <InitUserCryptoMethod 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 InitUserCryptoMethod

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 InitUserCryptoMethod

where InitUserCryptoMethod: Serialize,

fn none() -> Self::Abi

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

impl RefFromWasmAbi for InitUserCryptoMethod

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<InitUserCryptoMethod>

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 InitUserCryptoMethod

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 InitUserCryptoMethod

const DECL: &'static str = "/**\n * The crypto method used to initialize the user cryptographic state.\n */\nexport type InitUserCryptoMethod = { masterPasswordUnlock: { password: string; master_password_unlock: MasterPasswordUnlockData } } | { clientManagedState: {} } | { decryptedKey: { decrypted_user_key: string } } | { pin: { pin: string; pin_protected_user_key: EncString } } | { pinEnvelope: { pin: string; pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope } } | { authRequest: { request_private_key: B64; method: AuthRequestMethod } } | { deviceKey: { device_key: string; protected_device_private_key: EncString; device_protected_user_key: UnsignedSharedKey } } | { keyConnector: { master_key: B64; user_key: EncString } } | { keyConnectorUrl: { url: string; key_connector_key_wrapped_user_key: EncString } };"

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 InitUserCryptoMethod

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for InitUserCryptoMethod

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

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

impl VectorIntoWasmAbi for InitUserCryptoMethod

where InitUserCryptoMethod: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

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

impl WasmDescribe for InitUserCryptoMethod

fn describe()

impl WasmDescribeVector for InitUserCryptoMethod

fn describe_vector()