Class CrossSigningInfo

Hierarchy

CrossSigningInfo

Constructors

constructor

new CrossSigningInfo(userId: string, callbacks?: ICryptoCallbacks, cacheCallbacks?: ICacheCallbacks): CrossSigningInfo
Information about a user's cross-signing keys
Parameters
- userId: string
  
  the user that the information is about
- callbacks: ICryptoCallbacks = {}
  
  Callbacks used to interact with the app Requires getCrossSigningKey and saveCrossSigningKeys
- cacheCallbacks: ICacheCallbacks = {}
  
  Callbacks used to interact with the cache
Returns CrossSigningInfo
- Defined in src/crypto/CrossSigning.ts:74

Properties

`Private` cacheCallbacks

cacheCallbacks: ICacheCallbacks = {}

Callbacks used to interact with the cache

`Private` callbacks

callbacks: ICryptoCallbacks = {}

Callbacks used to interact with the app Requires getCrossSigningKey and saveCrossSigningKeys

`Private` crossSigningVerifiedBefore

crossSigningVerifiedBefore: boolean = false

firstUse

firstUse: boolean = true

keys

keys: Record<string, ICrossSigningKey> = {}

`Readonly` userId

userId: string

the user that the information is about

Methods

checkDeviceTrust

checkDeviceTrust(userCrossSigning: CrossSigningInfo, device: DeviceInfo, localTrust: boolean, trustCrossSignedDevices: boolean): DeviceTrustLevel
Check whether a given device is trusted.

Returns
Parameters
- userCrossSigning: CrossSigningInfo
  
  Cross signing info for user
- device: DeviceInfo
  
  The device to check
- localTrust: boolean
  
  Whether the device is trusted locally
- trustCrossSignedDevices: boolean
  
  Whether we trust cross signed devices
Returns DeviceTrustLevel
- Defined in src/crypto/CrossSigning.ts:529

checkUserTrust

checkUserTrust(userCrossSigning: CrossSigningInfo): UserTrustLevel
Check whether a given user is trusted.

Returns
Parameters
- userCrossSigning: CrossSigningInfo
  
  Cross signing info for user
Returns UserTrustLevel
- Defined in src/crypto/CrossSigning.ts:488

clearKeys

clearKeys(): void
unsets the keys, used when another session has reset the keys, to disable cross-signing

Returns void
- Defined in src/crypto/CrossSigning.ts:361

getCacheCallbacks

getCacheCallbacks(): ICacheCallbacks
Returns
Cache callbacks

Returns ICacheCallbacks
- Defined in src/crypto/CrossSigning.ts:560

getCrossSigningKey

getCrossSigningKey(type: string, expectedPubkey?: string): Promise<[string, PkSigning]>
Calls the app callback to ask for a private key

Returns
An array with [ public key, Olm.PkSigning ]
Parameters
- type: string
  
  The key type ("master", "self_signing", or "user_signing")
- Optional expectedPubkey: string
  
  The matching public key or undefined to use the stored public key for the given key type.
Returns Promise<[string, PkSigning]>
- Defined in src/crypto/CrossSigning.ts:107

getCrossSigningKeysFromCache

getCrossSigningKeysFromCache(): Promise<Map<string, Uint8Array>>
Get cross-signing private keys from the local cache.

Returns
A map from key type (string) to private key (Uint8Array)

Returns Promise<Map<string, Uint8Array>>
- Defined in src/crypto/CrossSigning.ts:244

getId

getId(type?: string): null | string
Get the ID used to identify the user. This can also be used to test for the existence of a given key type.

Returns
the ID
Parameters
- type: string = "master"
  
  The type of key to get the ID of. One of "master", "self_signing", or "user_signing". Defaults to "master".
Returns null | string
- Defined in src/crypto/CrossSigning.ts:267

isStoredInKeyCache

isStoredInKeyCache(type?: string): Promise<boolean>
Check whether the private keys exist in the local key cache.

Returns
True if all keys are stored in the local cache.
Parameters
- Optional type: string
  
  The type of key to get. One of "master", "self_signing", or "user_signing". Optional, will check all by default.
Returns Promise<boolean>
- Defined in src/crypto/CrossSigning.ts:227

isStoredInSecretStorage

isStoredInSecretStorage(secretStorage: SecretStorage<undefined | MatrixClient>): Promise<null | Record<string, object>>
Check whether the private keys exist in secret storage. XXX: This could be static, be we often seem to have an instance when we want to know this anyway...

Returns
map of key name to key info the secret is encrypted with, or null if it is not present or not encrypted with a trusted key
Parameters
- secretStorage: SecretStorage<undefined | MatrixClient>
  
  The secret store using account data
Returns Promise<null | Record<string, object>>
- Defined in src/crypto/CrossSigning.ts:166

resetKeys

resetKeys(level?: CrossSigningLevel): Promise<void>
Create new cross-signing keys for the given key types. The public keys will be held in this class, while the private keys are passed off to the saveCrossSigningKeys application callback.
Parameters
- Optional level: CrossSigningLevel
  
  The key types to reset
Returns Promise<void>
- Defined in src/crypto/CrossSigning.ts:280

setKeys

setKeys(keys: Record<string, ICrossSigningKey>): void
Parameters
- keys: Record<string, ICrossSigningKey>
Returns void
- Defined in src/crypto/CrossSigning.ts:365

signDevice

signDevice(userId: string, device: DeviceInfo): Promise<undefined | ISignedKey>
Parameters
- userId: string
- device: DeviceInfo
Returns Promise<undefined | ISignedKey>
- Defined in src/crypto/CrossSigning.ts:462

signObject

signObject<T>(data: T, type: string): Promise<T & {
signatures: ISignatures;
}>
Type Parameters
- T extends object
Parameters
- data: T
- type: string
Returns Promise<T & {
signatures: ISignatures;
}>
- Defined in src/crypto/CrossSigning.ts:441

signUser

signUser(key: CrossSigningInfo): Promise<undefined | ICrossSigningKey>
Parameters
- key: CrossSigningInfo
Returns Promise<undefined | ICrossSigningKey>
- Defined in src/crypto/CrossSigning.ts:454

toStorage

toStorage(): ICrossSigningInfo
Returns ICrossSigningInfo
- Defined in src/crypto/CrossSigning.ts:91

updateCrossSigningVerifiedBefore

updateCrossSigningVerifiedBefore(isCrossSigningVerified: boolean): void
Parameters
- isCrossSigningVerified: boolean
Returns void
- Defined in src/crypto/CrossSigning.ts:433

`Static` fromStorage

fromStorage(obj: ICrossSigningInfo, userId: string): CrossSigningInfo
Parameters
- obj: ICrossSigningInfo
- userId: string
Returns CrossSigningInfo
- Defined in src/crypto/CrossSigning.ts:80

`Static` getFromSecretStorage

getFromSecretStorage(type: string, secretStorage: SecretStorage<MatrixClient>): Promise<null | Uint8Array>
Get private keys from secret storage created by some other device. This also passes the private keys to the app-specific callback.

Returns
The private key
Parameters
- type: string
  
  The type of key to get. One of "master", "self_signing", or "user_signing".
- secretStorage: SecretStorage<MatrixClient>
  
  The secret store using account data
Returns Promise<null | Uint8Array>
- Defined in src/crypto/CrossSigning.ts:212

`Static` storeInSecretStorage

storeInSecretStorage(keys: Map<string, Uint8Array>, secretStorage: SecretStorage<undefined>): Promise<void>
Store private keys in secret storage for use by other devices. This is typically called in conjunction with the creation of new cross-signing keys.
Parameters
- keys: Map<string, Uint8Array>
  
  The keys to store
- secretStorage: SecretStorage<undefined>
  
  The secret store using account data
Returns Promise<void>
- Defined in src/crypto/CrossSigning.ts:193

Class CrossSigningInfo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

userId: string

callbacks: ICryptoCallbacks = {}

cacheCallbacks: ICacheCallbacks = {}

Returns CrossSigningInfo

Properties

Private cacheCallbacks

Private callbacks

Private crossSigningVerifiedBefore

firstUse

keys

Readonly userId

Methods

checkDeviceTrust

Returns

Parameters

userCrossSigning: CrossSigningInfo

device: DeviceInfo

localTrust: boolean

trustCrossSignedDevices: boolean

Returns DeviceTrustLevel

checkUserTrust

Returns

Parameters

userCrossSigning: CrossSigningInfo

Returns UserTrustLevel

clearKeys

Returns void

getCacheCallbacks

Returns

Returns ICacheCallbacks

getCrossSigningKey

Returns

Parameters

type: string

Optional expectedPubkey: string

Returns Promise<[string, PkSigning]>

getCrossSigningKeysFromCache

Returns

Returns Promise<Map<string, Uint8Array>>

getId

Returns

Parameters

type: string = "master"

Returns null | string

isStoredInKeyCache

Returns

Parameters

Optional type: string

Returns Promise<boolean>

isStoredInSecretStorage

Returns

Parameters

secretStorage: SecretStorage<undefined | MatrixClient>

Returns Promise<null | Record<string, object>>

resetKeys

Parameters

Optional level: CrossSigningLevel

Returns Promise<void>

setKeys

Parameters

keys: Record<string, ICrossSigningKey>

Returns void

signDevice

Parameters

userId: string

device: DeviceInfo

Returns Promise<undefined | ISignedKey>

signObject

Type Parameters

T extends object

Parameters

`Private` cacheCallbacks

`Private` callbacks

`Private` crossSigningVerifiedBefore

`Readonly` userId

`Optional` expectedPubkey: string

`Optional` type: string

`Optional` level: CrossSigningLevel

Returns Promise<T & {
signatures: ISignatures;
}>

`Static` fromStorage

`Static` getFromSecretStorage

`Static` storeInSecretStorage