Struct SecurityState

pub struct SecurityState {
    entity_id: Uuid,
    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

entity_id: Uuid

The entity ID is a permanent, unchangeable, unique identifier for the object this security state applies to. For users, this is the user ID, which never changes.

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 initialize_for_user(user_id: Uuid) -> 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: KeyIds>( &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 copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityState

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

Formats the value using the given formatter.

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 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.