Class FileStorage

Identity key storage base on @peculiar/webcrypto

Export

Hierarchy

RatchetStorage
- FileStorage

Constructors

constructor

new FileStorage(): FileStorage
Returns FileStorage

Inherited from RatchetStorage.constructor

Properties

identities

identities: IdentityList = {}

remoteIdentities

remoteIdentities: {
[key: string]: RemoteIdentity;
} = {}

Associative array of remote identities

Type declaration

[key: string]: RemoteIdentity

sessions

sessions: {
[key: string]: ratchet.AsymmetricRatchet;
} = {}

Type declaration

[key: string]: ratchet.AsymmetricRatchet

`Static` IDENTITY_STORAGE

IDENTITY_STORAGE: string = "identity"

`Static` REMOTE_STORAGE

REMOTE_STORAGE: string = "remoteIdentity"

`Static` SESSION_STORAGE

SESSION_STORAGE: string = "sessions"

`Static` STORAGE_NAME

STORAGE_NAME: string = DOUBLE_KEY_RATCHET_STORAGE_DIR

Methods

`Protected` create

create(): Promise<void>
Returns Promise<void>
Overrides RatchetStorage.create
- Defined in packages/server/src/connection/storages/file.ts:253

createIdentity

createIdentity(preKeyAmount?: number): Promise<Identity>
Parameters
- preKeyAmount: number = 10
Returns Promise<Identity>
Inherited from RatchetStorage.createIdentity
- Defined in packages/server/src/connection/storages/base.ts:24

`Protected` ecKeyToBase64

ecKeyToBase64(key: CryptoKey): Promise<string>
Parameters
- key: CryptoKey
Returns Promise<string>
- Defined in packages/server/src/connection/storages/file.ts:183

`Protected` ecKeyToCryptoKey

ecKeyToCryptoKey(base64: string, type: string, alg: string): Promise<CryptoKey>
Parameters
- base64: string
- type: string
- alg: string
Returns Promise<CryptoKey>
- Defined in packages/server/src/connection/storages/file.ts:195

findSession

findSession(key: CryptoKey): Promise<null | AsymmetricRatchet>
Parameters
- key: CryptoKey
Returns Promise<null | AsymmetricRatchet>
Overrides RatchetStorage.findSession
- Defined in packages/server/src/connection/storages/file.ts:173

getIdentity

getIdentity(origin: string): Promise<Identity>
Returns identity by domain origin. If identity doesn't exist creates new
Parameters
- origin: string
  
  Domain origin
Returns Promise<Identity>
Overrides RatchetStorage.getIdentity
- Defined in packages/server/src/connection/storages/file.ts:139

isTrusted

isTrusted(remoteIdentity: RemoteIdentity): Promise<boolean>
Parameters
- remoteIdentity: RemoteIdentity
Returns Promise<boolean>
Inherited from RatchetStorage.isTrusted
- Defined in packages/server/src/connection/storages/base.ts:49

loadIdentities

loadIdentities(): Promise<void>
Returns Promise<void>
Overrides RatchetStorage.loadIdentities
- Defined in packages/server/src/connection/storages/file.ts:57

`Protected` loadRemote

loadRemote(): Promise<void>
Returns Promise<void>
- Defined in packages/server/src/connection/storages/file.ts:234

loadRemoteIdentity

loadRemoteIdentity(key: string): Promise<null | RemoteIdentity>
Returns remote identity by key
Parameters
- key: string
  
  identifier of identity
Returns Promise<null | RemoteIdentity>
Overrides RatchetStorage.loadRemoteIdentity
- Defined in packages/server/src/connection/storages/file.ts:149

loadSession

loadSession(key: string): Promise<AsymmetricRatchet>
Parameters
- key: string
Returns Promise<AsymmetricRatchet>
Overrides RatchetStorage.loadSession
- Defined in packages/server/src/connection/storages/file.ts:164

removeRemoteIdentity

removeRemoteIdentity(key: string): Promise<void>
Remove remote identity from storage by key
Parameters
- key: string
  
  identifier of identity
Returns Promise<void>
Overrides RatchetStorage.removeRemoteIdentity
- Defined in packages/server/src/connection/storages/file.ts:159

saveIdentities

saveIdentities(): Promise<void>
Returns Promise<void>
Overrides RatchetStorage.saveIdentities
- Defined in packages/server/src/connection/storages/file.ts:102

`Protected` saveRemote

saveRemote(): Promise<void>
Returns Promise<void>
- Defined in packages/server/src/connection/storages/file.ts:211

saveRemoteIdentity

saveRemoteIdentity(key: string, value: RemoteIdentity): Promise<void>
Adds remote identity to storage
Parameters
- key: string
  
  identifier of identity
- value: RemoteIdentity
  
  remote identity
Returns Promise<void>
Overrides RatchetStorage.saveRemoteIdentity
- Defined in packages/server/src/connection/storages/file.ts:154

saveSession

saveSession(key: string, value: AsymmetricRatchet): Promise<void>
Parameters
- key: string
- value: AsymmetricRatchet
Returns Promise<void>
Overrides RatchetStorage.saveSession
- Defined in packages/server/src/connection/storages/file.ts:169

`Static` create

create<T>(this: (new () => T)): Promise<RatchetStorage>
Type Parameters
- T extends RatchetStorage<T>
Parameters
- this: (new () => T)
  - - new (): T
    - Returns T
Returns Promise<RatchetStorage>
Inherited from RatchetStorage.create
- Defined in packages/server/src/connection/storages/base.ts:9

Generated using TypeDoc