Class SocketProvider

Implementation of WebCrypto interface

getRandomValues native implementation
Symmetric cryptography uses native implementation
Asymmetric cryptography uses calls to Server

Hierarchy

EventEmitter
- SocketProvider

Index

Constructors

Properties

cardReader client FORTIFY

Accessors

Methods

challenge close connect getCrypto info isLoggedIn login on once

Constructors

constructor

new SocketProvider(options: SocketProviderOptions): SocketProvider
Parameters
- options: SocketProviderOptions
Returns SocketProvider
Overrides EventEmitter.constructor
- Defined in packages/client/src/client.ts:34

Properties

cardReader

cardReader: CardReader

client

client: Client

`Static` FORTIFY

FORTIFY: string = "127.0.0.1:31337"

Accessors

state

get state(): SocketCryptoState
Returns SocketCryptoState
- Defined in packages/client/src/client.ts:28

Methods

challenge

challenge(): Promise<string>
Returns Promise<string>
- Defined in packages/client/src/client.ts:110

close

close(): void
Close connection

Returns void
- Defined in packages/client/src/client.ts:90

connect

connect(address?: string, options?: ClientOptions): SocketProvider
Connects to Service Steps:
1. Requests info data from Server
- if server not found emits error
1. Create 2key-ratchet session from PreKeyBundle
Parameters
- address: string = SocketProvider.FORTIFY
  
  Address to WebCrypto server. Default value is Fortify address (127.0.0.1:31337)
- Optional options: ClientOptions
  
  WebSocket options
Returns SocketProvider
- Defined in packages/client/src/client.ts:50

getCrypto

getCrypto(cryptoID: string): Promise<SocketCrypto>
Parameters
- cryptoID: string
Returns Promise<SocketCrypto>
- Defined in packages/client/src/client.ts:122

info

info(): Promise<ProviderInfoProto>
Returns Promise<ProviderInfoProto>
- Defined in packages/client/src/client.ts:102

isLoggedIn

isLoggedIn(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/client/src/client.ts:114

login

login(): Promise<void>
Returns Promise<void>
- Defined in packages/client/src/client.ts:118

on

on(event: string | symbol, listener: ((...args: any[]) => void)): SocketProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SocketProvider
Overrides EventEmitter.on
- Defined in packages/client/src/client.ts:94

once

once(event: string | symbol, listener: ((...args: any[]) => void)): SocketProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns SocketProvider
Overrides EventEmitter.once
- Defined in packages/client/src/client.ts:98

Generated using TypeDoc