Class PolykeyAgent

Hierarchy

  • CreateDestroyStartStop
    • PolykeyAgent

Constructors

constructor

Properties

[initLock] _startTime _versionMetadata acl audit certManager clientService db discovery fs gestaltGraph identitiesManager keyRing logger nodeConnectionManager nodeGraph nodeManager nodePath notificationsManager schema sessionManager sigchain status taskManager vaultManager workerManager

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status] agentServiceHost agentServicePort clientServiceHost clientServicePort startTime versionMetadata

Methods

addEventListener destroy dispatchEvent handleEventCertManagerCertChange removeEventListener start stop createPolykeyAgent

Constructors

constructor

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected _startTime

_startTime: number = 0

Protected _versionMetadata

_versionMetadata: JSONObject

Readonly acl

acl: ACL

Readonly audit

audit: Audit

Readonly certManager

certManager: CertManager

Readonly clientService

clientService: ClientService

Readonly db

db: DB

Readonly discovery

discovery: Discovery

Readonly fs

fs: FileSystem

Readonly gestaltGraph

gestaltGraph: GestaltGraph

Readonly identitiesManager

identitiesManager: IdentitiesManager

Readonly keyRing

keyRing: KeyRing

Readonly logger

logger: Logger

Readonly nodeConnectionManager

nodeConnectionManager: NodeConnectionManager

Readonly nodeGraph

nodeGraph: NodeGraph

Readonly nodeManager

nodeManager: NodeManager

Readonly nodePath

nodePath: string

Readonly notificationsManager

notificationsManager: NotificationsManager

Readonly schema

schema: Schema

Readonly sessionManager

sessionManager: SessionManager

Readonly sigchain

sigchain: Sigchain

Readonly status

status: Status

Readonly taskManager

taskManager: TaskManager

Readonly vaultManager

vaultManager: VaultManager

Protected workerManager

workerManager: undefined | PolykeyWorkerManagerInterface

Accessors

[destroyed]

  • get [destroyed](): boolean

  • Returns boolean

[eventHandled]

  • get [eventHandled](): ReadonlyWeakSet<Event>

  • Returns ReadonlyWeakSet<Event>

[eventHandlers]

  • get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>

  • Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

  • get [eventTarget](): EventTarget

  • Returns EventTarget

[handleEventError]

  • get [handleEventError](): ((evt) => void)

  • Returns ((evt) => void)

      • (evt): void

      • Parameters

        • evt: EventError

        Returns void

[running]

  • get [running](): boolean

  • Returns boolean

[statusP]

  • get [statusP](): Promise<Status>

  • Returns Promise<Status>

[status]

  • get [status](): Status

  • Returns Status

agentServiceHost

agentServicePort

clientServiceHost

clientServicePort

startTime

  • get startTime(): number

  • Returns the time the PolykeyAgent was started at in milliseconds since Unix epoch

    Returns number

versionMetadata

Methods

addEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

destroy

  • Parameters

    • password: string

    Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

Protected handleEventCertManagerCertChange

removeEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

start

  • Parameters

    • __namedParameters: {
          fresh?: boolean;
          options?: {
              agentServiceHost?: string;
              agentServicePort?: number;
              clientServiceHost?: string;
              clientServicePort?: number;
              ipv6Only?: boolean;
              keys?: ({}) | ({ recoveryCode?: string | undefined; }) | ({ privateKey?: { [x: number]: number | undefined; write?: {} | undefined; toString?: {} | undefined; toJSON?: {} | undefined; equals?: {} | undefined; compare?: {} | undefined; copy?: {} | undefined; ... 97 more ...; readonly [Symbol.toStringTag]?: "Uint8Array" | undefined; } | undefined; }) | ({ privateKeyPath?: string | undefined; });
              mdns?: { groups?: (string | undefined)[] | undefined; port?: number | undefined; };
              network?: string;
              seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: [({ [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined)?, ({ ...; } | undefined)?] | undefin...;
              workers?: number;
          };
          password: string;
          workers?: number;
      }
      • Optional fresh?: boolean
      • Optional options?: {
            agentServiceHost?: string;
            agentServicePort?: number;
            clientServiceHost?: string;
            clientServicePort?: number;
            ipv6Only?: boolean;
            keys?: ({}) | ({ recoveryCode?: string | undefined; }) | ({ privateKey?: { [x: number]: number | undefined; write?: {} | undefined; toString?: {} | undefined; toJSON?: {} | undefined; equals?: {} | undefined; compare?: {} | undefined; copy?: {} | undefined; ... 97 more ...; readonly [Symbol.toStringTag]?: "Uint8Array" | undefined; } | undefined; }) | ({ privateKeyPath?: string | undefined; });
            mdns?: { groups?: (string | undefined)[] | undefined; port?: number | undefined; };
            network?: string;
            seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: [({ [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined)?, ({ ...; } | undefined)?] | undefin...;
            workers?: number;
        }
        • Optional agentServiceHost?: string
        • Optional agentServicePort?: number
        • Optional clientServiceHost?: string
        • Optional clientServicePort?: number
        • Optional ipv6Only?: boolean
        • Optional keys?: ({}) | ({ recoveryCode?: string | undefined; }) | ({ privateKey?: { [x: number]: number | undefined; write?: {} | undefined; toString?: {} | undefined; toJSON?: {} | undefined; equals?: {} | undefined; compare?: {} | undefined; copy?: {} | undefined; ... 97 more ...; readonly [Symbol.toStringTag]?: "Uint8Array" | undefined; } | undefined; }) | ({ privateKeyPath?: string | undefined; })
        • Optional mdns?: { groups?: (string | undefined)[] | undefined; port?: number | undefined; }
        • Optional network?: string
        • Optional seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: [({ [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined)?, ({ ...; } | undefined)?] | undefin...
        • Optional workers?: number
      • password: string
      • Optional workers?: number

    Returns Promise<void>

stop

  • Asynchronously stops the PolykeyAgent

    Returns Promise<void>

Static createPolykeyAgent

  • Create the Polykey Agent.

    All optional configuration is deep-merged with defaults.

    If any of the optional dependencies is injected, their lifecycle will not be managed by PolykeyAgent. Furthermore, if you inject an optional dependency, make sure you are injecting all upstream transitive dependencies at the same time. For example if you inject acl, you must also inject db.

    Parameters

    • __namedParameters: {
          fresh?: boolean;
          fs?: FileSystem;
          logger?: Logger;
          options?: {
              agentServiceHost?: string;
              agentServicePort?: number;
              client?: { keepAliveTimeoutTime?: number | undefined; keepAliveIntervalTime?: number | undefined; rpcCallTimeoutTime?: number | undefined; rpcParserBufferSize?: number | undefined; rpcMiddlewareFactory?: {} | undefined; };
              clientServiceHost?: string;
              clientServicePort?: number;
              ipv6Only?: boolean;
              keys?: ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; recoveryCode?: string | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; recoveryCode?: string | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 5 more ...; privateKey?: { ...; } | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 5 more ...; privateKeyPath?: string | undefined; });
              mdns?: { groups?: (string | undefined)[] | undefined; port?: number | undefined; };
              network?: string;
              nodePath?: string;
              nodes?: { connectionIdleTimeoutTimeMin?: number | undefined; connectionIdleTimeoutTimeScale?: number | undefined; connectionFindConcurrencyLimit?: number | undefined; connectionConnectTimeoutTime?: number | undefined; ... 7 more ...; dnsServers?: (string | undefined)[] | undefined; };
              seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: [({ [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined)?, ({ ...; } | undefined)?] | undefin...;
              versionMetadata?: { [x: string]: any; };
              workers?: number;
          };
          password: string;
      }
      • Optional fresh?: boolean
      • Optional fs?: FileSystem
      • Optional logger?: Logger
      • Optional options?: {
            agentServiceHost?: string;
            agentServicePort?: number;
            client?: { keepAliveTimeoutTime?: number | undefined; keepAliveIntervalTime?: number | undefined; rpcCallTimeoutTime?: number | undefined; rpcParserBufferSize?: number | undefined; rpcMiddlewareFactory?: {} | undefined; };
            clientServiceHost?: string;
            clientServicePort?: number;
            ipv6Only?: boolean;
            keys?: ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; recoveryCode?: string | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; recoveryCode?: string | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 5 more ...; privateKey?: { ...; } | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 5 more ...; privateKeyPath?: string | undefined; });
            mdns?: { groups?: (string | undefined)[] | undefined; port?: number | undefined; };
            network?: string;
            nodePath?: string;
            nodes?: { connectionIdleTimeoutTimeMin?: number | undefined; connectionIdleTimeoutTimeScale?: number | undefined; connectionFindConcurrencyLimit?: number | undefined; connectionConnectTimeoutTime?: number | undefined; ... 7 more ...; dnsServers?: (string | undefined)[] | undefined; };
            seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: [({ [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined)?, ({ ...; } | undefined)?] | undefin...;
            versionMetadata?: { [x: string]: any; };
            workers?: number;
        }
        • Optional agentServiceHost?: string
        • Optional agentServicePort?: number
        • Optional client?: { keepAliveTimeoutTime?: number | undefined; keepAliveIntervalTime?: number | undefined; rpcCallTimeoutTime?: number | undefined; rpcParserBufferSize?: number | undefined; rpcMiddlewareFactory?: {} | undefined; }
        • Optional clientServiceHost?: string
        • Optional clientServicePort?: number
        • Optional ipv6Only?: boolean
        • Optional keys?: ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; recoveryCode?: string | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 4 more ...; recoveryCode?: string | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 5 more ...; privateKey?: { ...; } | undefined; }) | ({ passwordOpsLimit?: { toString?: {} | undefined; toFixed?: {} | undefined; toExponential?: {} | undefined; toPrecision?: {} | undefined; valueOf?: {} | undefined; toLocaleString?: {} | undefined; readonly [brand]?: "PasswordOpsLimit" | undefined; } | undefined; ... 5 more ...; privateKeyPath?: string | undefined; })
        • Optional mdns?: { groups?: (string | undefined)[] | undefined; port?: number | undefined; }
        • Optional network?: string
        • Optional nodePath?: string
        • Optional nodes?: { connectionIdleTimeoutTimeMin?: number | undefined; connectionIdleTimeoutTimeScale?: number | undefined; connectionFindConcurrencyLimit?: number | undefined; connectionConnectTimeoutTime?: number | undefined; ... 7 more ...; dnsServers?: (string | undefined)[] | undefined; }
        • Optional seedNodes?: { [x: string & { readonly [brand]: "NodeIdEncoded"; }]: [({ [x: number]: string | undefined; toString?: {} | undefined; charAt?: {} | undefined; charCodeAt?: {} | undefined; concat?: {} | undefined; ... 46 more ...; readonly [brand]?: "Host" | undefined; } | { ...; } | undefined)?, ({ ...; } | undefined)?] | undefin...
        • Optional versionMetadata?: { [x: string]: any; }
        • Optional workers?: number
      • password: string

    Returns Promise<PolykeyAgent>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc