Enum WrappedAccountCryptographicState

pub enum WrappedAccountCryptographicState {
    V1 {
        private_key: EncString,
    },
    V2 {
        private_key: EncString,
        signed_public_key: Option<SignedPublicKey>,
        signing_key: EncString,
        security_state: SignedSecurityState,
    },
}

Any keys / cryptographic protection “downstream” from the account symmetric key (user key). Private keys are protected by the user key.

Variants

V1

A V1 user has only a private key.

Fields

private_key: EncString

The user’s encryption private key, wrapped by the user key.

V2

A V2 user has a private key, a signing key, a signed public key and a signed security state. The SignedPublicKey ensures that others can verify the public key is claimed by an identity they want to share data to. The signed security state protects against cryptographic downgrades.

Fields

private_key: EncString

The user’s encryption private key, wrapped by the user key.

signed_public_key: Option<SignedPublicKey>

The user’s public-key for the private key, signed by the user’s signing key. Note: This is optional for backwards compatibility. After a few releases, this will be made non-optional once all clients store the response on sync.

signing_key: EncString

The user’s signing key, wrapped by the user key.

security_state: SignedSecurityState

The user’s signed security state.

Implementations

impl WrappedAccountCryptographicState

pub fn to_request_model( &self, store: &KeyStore<KeyIds>, ) -> Result<AccountKeysRequestModel, AccountCryptographyInitializationError>

Converts to a AccountKeysRequestModel in order to make API requests. Since the WrappedAccountCryptographicState is encrypted, the key store needs to contain the user key required to unlock this state.

pub fn make( ctx: &mut KeyStoreContext<'_, KeyIds>, user_id: UserId, ) -> Result<(SymmetricKeyId, Self), AccountCryptographyInitializationError>

Creates a new V2 account cryptographic state with fresh keys. This does not change the user state, but does set some keys to the local context.

pub(crate) fn set_to_context( &self, security_state_rwlock: &RwLock<Option<SecurityState>>, user_key: SymmetricKeyId, store: &KeyStore<KeyIds>, ctx: KeyStoreContext<'_, KeyIds>, ) -> Result<(), AccountCryptographyInitializationError>

Set the decrypted account cryptographic state to the context’s non-local storage. This needs a mutable context passed in that already has a user_key set to a local key slot, for which the id is passed in as user_key. Note, that this function drops the context and clears the existing local state, after persisting it.

fn verifying_key( &self, store: &KeyStore<KeyIds>, ) -> Result<Option<VerifyingKey>, AccountCryptographyInitializationError>

Retrieve the verifying key from the wrapped state, if present. This requires the user key to be present in the store.

fn public_key( &self, store: &KeyStore<KeyIds>, ) -> Result<Option<AsymmetricPublicCryptoKey>, AccountCryptographyInitializationError>

Retrieve the public key from the wrapped state, if present. This requires the user key to be present in the store.

fn signed_public_key( &self, ) -> Result<Option<&SignedPublicKey>, AccountCryptographyInitializationError>

Retrieve the signed public key from the wrapped state, if present.

Trait Implementations

impl Clone for WrappedAccountCryptographicState

fn clone(&self) -> WrappedAccountCryptographicState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for WrappedAccountCryptographicState

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

impl Debug for WrappedAccountCryptographicState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WrappedAccountCryptographicState

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 WrappedAccountCryptographicState

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

where WrappedAccountCryptographicState: Serialize,

fn from(value: WrappedAccountCryptographicState) -> Self

Converts to this type from the input type.

impl FromWasmAbi for WrappedAccountCryptographicState

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 WrappedAccountCryptographicState

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

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

type LiftType = WrappedAccountCryptographicState

impl<UT> LiftReturn<UT> for WrappedAccountCryptographicState

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for WrappedAccountCryptographicState

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

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 WrappedAccountCryptographicState

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

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<WrappedAccountCryptographicState>

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 WrappedAccountCryptographicState

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 WrappedAccountCryptographicState

const DECL: &'static str = "/**\n * Any keys / cryptographic protection \\\"downstream\\\" from the account symmetric key (user key).\n * Private keys are protected by the user key.\n */\nexport type WrappedAccountCryptographicState = { V1: { private_key: EncString } } | { V2: { private_key: EncString; signed_public_key: SignedPublicKey | undefined; signing_key: EncString; security_state: SignedSecurityState } };"

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 WrappedAccountCryptographicState

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for WrappedAccountCryptographicState

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

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

impl VectorIntoWasmAbi for WrappedAccountCryptographicState

where WrappedAccountCryptographicState: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

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

impl WasmDescribe for WrappedAccountCryptographicState

fn describe()

impl WasmDescribeVector for WrappedAccountCryptographicState

fn describe_vector()