Struct SecurityState 

pub struct SecurityState {
    version: u64,
}

The security state is a signed object attesting to the security state of a user.

It contains a version, which can only ever increment. Based on the version, old formats and features are blocked. This prevents a server from downgrading a user’s account features, because only the user can create this signed object.

Fields

version: u64

The version of the security state gates feature availability. It can only ever be incremented. Components can use it to gate format support of specific formats (like item url hashes).

Implementations

impl SecurityState

pub fn new() -> Self

Initialize a new SecurityState for the given user ID, to the lowest version possible. The user needs to be a v2 encryption user.

pub fn version(&self) -> u64

Returns the version of the security state

pub fn sign<Ids: KeySlotIds>( &self, signing_key_id: Ids::Signing, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<SignedSecurityState, CryptoError>

Signs the SecurityState with the provided signing key ID from the context.

Trait Implementations

impl Clone for SecurityState

fn clone(&self) -> SecurityState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for SecurityState

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

impl Debug for SecurityState

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

Formats the value using the given formatter.

impl Default for SecurityState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecurityState

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 SecurityState

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<UT> Lift<UT> for SecurityState

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

type LiftType = SecurityState

impl<UT> LiftReturn<UT> for SecurityState

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SecurityState

type ReturnType = <SecurityState 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 Serialize for SecurityState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<UT> TypeId<UT> for SecurityState

const TYPE_ID_META: MetadataBuffer