Skip to main content

WrappedAccountCryptographicState

Enum WrappedAccountCryptographicState 

Source
pub enum WrappedAccountCryptographicState {
    V1 {
        private_key: EncString,
    },
    V2 {
        private_key: EncString,
        signed_public_key: SignedPublicKey,
        signing_key: EncString,
        security_state: SignedSecurityState,
    },
}
Expand description

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: SignedPublicKey

The user’s public-key for the private key, signed by the user’s signing key.

§signing_key: EncString

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

§security_state: SignedSecurityState

The user’s signed security state.

Implementations§

Source§

impl WrappedAccountCryptographicState

Source

pub fn to_wrapped_request_model( &self, user_key: &SymmetricKeySlotId, ctx: &mut KeyStoreContext<'_, KeySlotIds>, ) -> Result<WrappedAccountCryptographicStateRequestModel, AccountCryptographyInitializationError>

Converts to a WrappedAccountCryptographicStateRequestModel 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. This request model only supports v2 encryption.

Source

pub fn to_request_model( &self, user_key: &SymmetricKeySlotId, ctx: &mut KeyStoreContext<'_, KeySlotIds>, ) -> 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.

Source

pub fn make( ctx: &mut KeyStoreContext<'_, KeySlotIds>, ) -> Result<(SymmetricKeySlotId, 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.

Source

pub fn get_from_key_store( ctx: &KeyStoreContext<'_, KeySlotIds>, ) -> Result<Self, RotateCryptographyStateError>

Reads the current account cryptographic state from the key store by wrapping the user’s private key with the user key.

Currently only supports V1 accounts.

This is useful for obtaining the wrapped state after an asymmetric key regeneration.

Source

pub fn rotate( &self, current_user_key: &SymmetricKeySlotId, new_user_key: &SymmetricKeySlotId, ctx: &mut KeyStoreContext<'_, KeySlotIds>, ) -> Result<Self, RotateCryptographyStateError>

Re-wraps the account cryptographic state with a new user key. If the cryptographic state is a V1 state, it gets upgraded to a V2 state

Source

pub(crate) fn set_to_context( &self, security_state_rwlock: &RwLock<Option<SecurityState>>, user_key: SymmetricKeySlotId, store: &KeyStore<KeySlotIds>, ctx: KeyStoreContext<'_, KeySlotIds>, ) -> 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.

Source

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

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

Trait Implementations§

Source§

impl Clone for WrappedAccountCryptographicState

Source§

fn clone(&self) -> WrappedAccountCryptographicState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<UT> ConvertError<UT> for WrappedAccountCryptographicState

Source§

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

Source§

impl Debug for WrappedAccountCryptographicState

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<UT> FfiConverter<UT> for WrappedAccountCryptographicState

Source§

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].
Source§

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI. Read more
Source§

fn lower(v: Self) -> RustBuffer

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

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

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

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

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

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

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

impl FromWasm for WrappedAccountCryptographicState

Available on crate feature wasm only.
Source§

type Wire = Ts<WrappedAccountCryptographicState>

The type JavaScript actually passes.
Source§

fn from_wire(wire: Self::Wire) -> Result<Self, WireError>

Recovers the Rust value from the wire value.
Source§

impl<UT> Lift<UT> for WrappedAccountCryptographicState

Source§

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

Source§

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

Source§

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

§

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

Convenience method
Source§

impl<UT> LiftRef<UT> for WrappedAccountCryptographicState

Source§

impl<UT> LiftReturn<UT> for WrappedAccountCryptographicState

Source§

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

FFI return type for trait interfaces
Source§

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 Read more
§

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result Read more
§

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error Read more
Source§

impl<UT> Lower<UT> for WrappedAccountCryptographicState

Source§

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

Source§

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

Source§

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

§

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method
Source§

impl<UT> LowerError<UT> for WrappedAccountCryptographicState

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for WrappedAccountCryptographicState

Source§

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

The type that should be returned by scaffolding functions for this type. Read more
Source§

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

Lower the return value from an scaffolding call Read more
§

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

Lower the return value for failed argument lifts Read more
Source§

impl PartialEq for WrappedAccountCryptographicState

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for WrappedAccountCryptographicState

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for WrappedAccountCryptographicState

Source§

impl ToWasm for WrappedAccountCryptographicState

Available on crate feature wasm only.
Source§

type Wire = Ts<WrappedAccountCryptographicState>

The type JavaScript actually receives.
Source§

fn to_wire(self) -> Result<Self::Wire, WireError>

Converts the Rust value into the wire value.
Source§

impl TryFrom<&PrivateKeysResponseModel> for WrappedAccountCryptographicState

Source§

type Error = AccountKeysResponseParseError

The type returned in the event of a conversion error.
Source§

fn try_from(response: &PrivateKeysResponseModel) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<JsValue> for WrappedAccountCryptographicState

Available on crate feature wasm only.
Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Tsify for WrappedAccountCryptographicState

Source§

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; signing_key: EncString; security_state: SignedSecurityState } };"

Source§

const SERIALIZATION_CONFIG: SerializationConfig

Source§

type JsType = JsType

Must be a type imported through #[wasm_bindgen] extern "C" { .. }. [Ts<T>] is #[repr(transparent)] over this and passes it across the ABI as a plain JS handle, which any other representation would break.
§

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,

§

fn into_ts(&self) -> Result<Ts<Self>, Error>
where Self: Sized + Serialize,

Calls Ts::from_rust on self, returning a Result<Ts<Self>, crate::Error>. Read more
Source§

impl<UT> TypeId<UT> for WrappedAccountCryptographicState

Source§

const TYPE_ID_META: MetadataBuffer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T> ⓘ
where T: Sized,

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T> ⓘ

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T> ⓘ

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T> ⓘ

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self> ⓘ

Get a clone of the Arc<> using a “borrowed” handle. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Persist for T
where T: Serialize + DeserializeOwned + Send + Sync + 'static,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more