Class DeviceTrustLevel

Represents the ways in which we trust a device.

Deprecated

Use DeviceVerificationStatus.

Hierarchy (View Summary)

DeviceVerificationStatus
- DeviceTrustLevel

Index

Constructors

constructor

new DeviceTrustLevel(
    crossSigningVerified: boolean,
    tofu: boolean,
    localVerified: boolean,
    trustCrossSignedDevices: boolean,
    signedByOwner?: boolean,
): DeviceTrustLevel
Parameters
- crossSigningVerified: boolean
- tofu: boolean
- localVerified: boolean
- trustCrossSignedDevices: boolean
- signedByOwner: boolean = false
Returns DeviceTrustLevel
Overrides DeviceVerificationStatus.constructor
- Defined in src/crypto/CrossSigning.ts:605

Properties

`Readonly`crossSigningVerified

crossSigningVerified: boolean

True if this device has been verified via cross signing.

This does not take into account trustCrossSignedDevices.

`Readonly`localVerified

localVerified: boolean

True if the device has been marked as locally verified.

`Readonly`signedByOwner

signedByOwner: boolean

True if this device has been signed by its owner (and that signature verified).

This doesn't necessarily mean that we have verified the device, since we may not have verified the owner's cross-signing key.

`Readonly`tofu

tofu: boolean

TODO: tofu magic wtf does this do?

Methods

isCrossSigningVerified

isCrossSigningVerified(): boolean
Returns boolean
true if this device is verified via cross signing
- Defined in src/crypto/CrossSigning.ts:632

isLocallyVerified

isLocallyVerified(): boolean
Returns boolean
true if this device is verified locally
- Defined in src/crypto/CrossSigning.ts:639

isTofu

isTofu(): boolean
Returns boolean
true if this device is trusted from a user's key that is trusted on first use
- Defined in src/crypto/CrossSigning.ts:647

isVerified

isVerified(): boolean
Check if we should consider this device "verified".

A device is "verified" if either:
- it has been manually marked as such via matrix.MatrixClient.setDeviceVerified.
- it has been cross-signed with a verified signing key, and the client has been configured to trust cross-signed devices via CryptoApi.setTrustCrossSignedDevices.
Returns boolean
true if this device is verified via any means.
Inherited from DeviceVerificationStatus.isVerified
- Defined in src/crypto-api/index.ts:942

`Static`fromUserTrustLevel

fromUserTrustLevel(
    userTrustLevel: UserVerificationStatus,
    localVerified: boolean,
    trustCrossSignedDevices: boolean,
): DeviceTrustLevel
Parameters
- userTrustLevel: UserVerificationStatus
- localVerified: boolean
- trustCrossSignedDevices: boolean
Returns DeviceTrustLevel
- Defined in src/crypto/CrossSigning.ts:615

Class DeviceTrustLevel

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeviceTrustLevel

Properties

`Readonly`crossSigningVerified

`Readonly`localVerified

`Readonly`signedByOwner

`Readonly`tofu

Methods

isCrossSigningVerified

Returns boolean

isLocallyVerified

Returns boolean

isTofu

Returns boolean

isVerified

Returns boolean

`Static`fromUserTrustLevel

Parameters

Returns DeviceTrustLevel

Settings

On This Page

Class DeviceTrustLevel

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeviceTrustLevel

Properties

ReadonlycrossSigningVerified

ReadonlylocalVerified

ReadonlysignedByOwner

Readonlytofu

Methods

isCrossSigningVerified

Returns boolean

isLocallyVerified

Returns boolean

isTofu

Returns boolean

isVerified

Returns boolean

StaticfromUserTrustLevel

Parameters

Returns DeviceTrustLevel

Settings

On This Page

`Readonly`crossSigningVerified

`Readonly`localVerified

`Readonly`signedByOwner

`Readonly`tofu

`Static`fromUserTrustLevel