Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserIdentity

Struct representing a cross signing identity of a user.

This is the user identity of a user that isn't our own. Other users will only contain a master key and a self signing key, meaning that only device signatures can be checked with this identity.

This struct wraps a read-only version of the struct and allows verifications to be requested to verify our own device with the user identity.

Hierarchy

  • UserIdentity

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly masterKey

masterKey: string

Get the master key of the identity.

Readonly selfSigningKey

selfSigningKey: string

Get the self-signing key of the identity.

Methods

free

  • free(): void

  • Returns void

hasVerificationViolation

  • hasVerificationViolation(): boolean

  • Was this identity verified since initial observation and is not anymore?

    Such a violation should be reported to the local user by the application, and resolved by

    Returns boolean

identityNeedsUserApproval

  • identityNeedsUserApproval(): boolean

  • Has the identity changed in a way that requires approval from the user?

    A user identity needs approval if it changed after the crypto machine has already observed ("pinned") a different identity for that user, unless it is an explicitly verified identity (using for example interactive verification).

    This situation can be resolved by:

    Returns boolean

isVerified

  • isVerified(): boolean

  • Is this user identity verified?

    Returns boolean

pinCurrentMasterKey

  • pinCurrentMasterKey(): Promise<any>

  • Pin the current identity (public part of the master signing key).

    Returns Promise<any>

requestVerification

  • Create a VerificationRequest object after the verification request content has been sent out.

    Parameters

    Returns VerificationRequest

verificationRequestContent

  • verificationRequestContent(methods?: any[]): string

  • Send a verification request to the given user.

    The returned content needs to be sent out into a DM room with the given user.

    After the content has been sent out a VerificationRequest can be started with the request_verification method.

    Parameters

    • Optional methods: any[]

    Returns string

verify

  • verify(): Promise<any>

  • Manually verify this user.

    This method will attempt to sign the user identity using our private cross signing key.

    This method fails if we don't have the private part of our user-signing key.

    Returns a request that needs to be sent out for the user to be marked as verified.

    Returns Promise<any>

wasPreviouslyVerified

  • wasPreviouslyVerified(): boolean

  • True if we verified this identity (with any own identity, at any point).

    To set this latch back to false, call withdrawVerification.

    Returns boolean

withdrawVerification

  • withdrawVerification(): Promise<any>

  • Remove the requirement for this identity to be verified.

    If an identity was previously verified and is not anymore it will be reported to the user. In order to remove this notice users have to verify again or to withdraw the verification requirement.

    Returns Promise<any>

Generated using TypeDoc