Class PolykeyClient

Hierarchy

  • CreateDestroyStartStop
    • PolykeyClient

Constructors

constructor

Properties

[initLock] _nodeId _rpcClient _webSocketClient fs logger nodePath session

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status] host localHost localPort nodeId port rpcClient webSocketClient

Methods

addEventListener destroy dispatchEvent handleEventWebSocketClientDestroyed removeEventListener start stop createPolykeyClient

Constructors

constructor

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected _nodeId

_nodeId: NodeId

Protected _rpcClient

_rpcClient: OverrideRPClientType<RPCClient<{
    agentLockAll: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    agentStatus: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<StatusResultMessage>>;
    agentStop: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    agentUnlock: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    auditEventsGet: ServerCaller<ClientRPCRequestParams<{
        awaitFutureEvents?: boolean;
        limit?: number;
        order?: "asc" | "desc";
        paths: TopicSubPath[];
        seek?: number | AuditEventIdEncoded;
        seekEnd?: number | AuditEventIdEncoded;
    }>, ClientRPCResponseResult<AuditEventSerialized>>;
    auditMetricGet: UnaryCaller<ClientRPCRequestParams<{
        path: Object;
        seek?: number | AuditEventIdEncoded;
        seekEnd?: number | AuditEventIdEncoded;
    }>, ClientRPCResponseResult<AuditMetricNodeConnection>>;
    gestaltsActionsGetByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<{
        actionsList: ("notify" | "scan" | "claim")[];
    }>>;
    gestaltsActionsGetByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<ActionsListMessage>>;
    gestaltsActionsSetByIdentity: UnaryCaller<ClientRPCRequestParams<SetIdentityActionMessage>, ClientRPCResponseResult>;
    gestaltsActionsSetByNode: UnaryCaller<ClientRPCRequestParams<SetNodeActionMessage>, ClientRPCResponseResult>;
    gestaltsActionsUnsetByIdentity: UnaryCaller<ClientRPCRequestParams<SetIdentityActionMessage>, ClientRPCResponseResult>;
    gestaltsActionsUnsetByNode: UnaryCaller<ClientRPCRequestParams<SetNodeActionMessage>, ClientRPCResponseResult>;
    gestaltsDiscoveryByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult>;
    gestaltsDiscoveryByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult>;
    gestaltsDiscoveryQueue: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<DiscoveryQueueInfo>>;
    gestaltsGestaltGetByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<GestaltMessage>>;
    gestaltsGestaltGetByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<GestaltMessage>>;
    gestaltsGestaltList: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<GestaltMessage>>;
    gestaltsGestaltTrustByIdentity: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult>;
    gestaltsGestaltTrustByNode: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult>;
    identitiesAuthenticate: ServerCaller<ClientRPCRequestParams<{
        providerId: string;
    }>, ClientRPCResponseResult<AuthProcessMessage>>;
    identitiesAuthenticatedGet: ServerCaller<ClientRPCRequestParams<{
        providerId?: string;
    }>, ClientRPCResponseResult<IdentityMessage>>;
    identitiesClaim: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<client.types.ClaimIdMessage>>;
    identitiesInfoConnectedGet: ServerCaller<ClientRPCRequestParams<ProviderSearchMessage>, ClientRPCResponseResult<IdentityInfoMessage>>;
    identitiesInfoGet: ServerCaller<ClientRPCRequestParams<ProviderSearchMessage>, ClientRPCResponseResult<IdentityInfoMessage>>;
    identitiesInvite: UnaryCaller<ClientRPCRequestParams<ClaimNodeMessage>, ClientRPCResponseResult>;
    identitiesProvidersList: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<{
        providerIds: string[];
    }>>;
    identitiesTokenDelete: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult>;
    identitiesTokenGet: UnaryCaller<ClientRPCRequestParams<IdentityMessage>, ClientRPCResponseResult<Partial<TokenMessage>>>;
    identitiesTokenPut: UnaryCaller<ClientRPCRequestParams<IdentityMessage & TokenMessage>, ClientRPCResponseResult>;
    keysCertsChainGet: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<CertMessage>>;
    keysCertsGet: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<CertMessage>>;
    keysDecrypt: UnaryCaller<ClientRPCRequestParams<DataMessage>, ClientRPCResponseResult<DataMessage>>;
    keysEncrypt: UnaryCaller<ClientRPCRequestParams<DecryptMessage>, ClientRPCResponseResult<DataMessage>>;
    keysKeyPair: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult<KeyPairMessage>>;
    keysKeyPairRenew: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult>;
    keysKeyPairReset: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult>;
    keysPasswordChange: UnaryCaller<ClientRPCRequestParams<PasswordMessage>, ClientRPCResponseResult>;
    keysPublicKey: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult<PublicKeyMessage>>;
    keysSign: UnaryCaller<ClientRPCRequestParams<DataMessage>, ClientRPCResponseResult<SignatureMessage>>;
    keysVerify: UnaryCaller<ClientRPCRequestParams<VerifySignatureMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    nodesAdd: UnaryCaller<ClientRPCRequestParams<NodesAddMessage>, ClientRPCResponseResult>;
    nodesClaim: UnaryCaller<ClientRPCRequestParams<ClaimNodeMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    nodesFind: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<NodesFindMessage>>;
    nodesGetAll: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<NodesGetMessage>>;
    nodesListConnections: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<NodeConnectionMessage>>;
    nodesPing: UnaryCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    notificationsInboxClear: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    notificationsInboxRead: ServerCaller<ClientRPCRequestParams<NotificationReadMessage>, ClientRPCResponseResult<NotificationInboxMessage>>;
    notificationsInboxRemove: UnaryCaller<ClientRPCRequestParams<NotificationRemoveMessage>, ClientRPCResponseResult>;
    notificationsOutboxClear: UnaryCaller<ClientRPCRequestParams, ClientRPCResponseResult>;
    notificationsOutboxRead: ServerCaller<ClientRPCRequestParams<NotificationOutboxReadMessage>, ClientRPCResponseResult<NotificationOutboxMessage>>;
    notificationsOutboxRemove: UnaryCaller<ClientRPCRequestParams<NotificationRemoveMessage>, ClientRPCResponseResult>;
    notificationsSend: UnaryCaller<ClientRPCRequestParams<NotificationSendMessage>, ClientRPCResponseResult>;
    vaultsClone: UnaryCaller<ClientRPCRequestParams<CloneMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsCreate: UnaryCaller<ClientRPCRequestParams<VaultNameMessage>, ClientRPCResponseResult<VaultIdMessage>>;
    vaultsDelete: UnaryCaller<ClientRPCRequestParams<VaultIdentifierMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsList: ServerCaller<ClientRPCRequestParams, ClientRPCResponseResult<VaultListMessage>>;
    vaultsLog: ServerCaller<ClientRPCRequestParams<VaultsLogMessage>, ClientRPCResponseResult<LogEntryMessage>>;
    vaultsPermissionGet: ServerCaller<ClientRPCRequestParams<VaultIdentifierMessage>, ClientRPCResponseResult<VaultPermissionMessage>>;
    vaultsPermissionSet: UnaryCaller<ClientRPCRequestParams<PermissionSetMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsPermissionUnset: UnaryCaller<ClientRPCRequestParams<PermissionSetMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsPull: UnaryCaller<ClientRPCRequestParams<VaultsPullMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsRename: UnaryCaller<ClientRPCRequestParams<VaultsRenameMessage>, ClientRPCResponseResult<VaultIdMessage>>;
    vaultsScan: ServerCaller<ClientRPCRequestParams<client.types.NodeIdMessage>, ClientRPCResponseResult<client.types.VaultsScanMessage>>;
    vaultsSecretsCat: DuplexCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<ContentOrErrorMessage>>;
    vaultsSecretsEnv: DuplexCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<SecretContentMessage>>;
    vaultsSecretsList: ServerCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<SecretFilesMessage>>;
    vaultsSecretsMkdir: DuplexCaller<ClientRPCRequestParams<SecretDirMessage>, ClientRPCResponseResult<SuccessOrErrorMessageTagged>>;
    vaultsSecretsNewDir: UnaryCaller<ClientRPCRequestParams<SecretDirMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsSecretsRemove: DuplexCaller<ClientRPCRequestParams<SecretIdentifierMessageTagged | SecretsRemoveHeaderMessage>, ClientRPCResponseResult<SuccessOrErrorMessageTagged>>;
    vaultsSecretsRename: UnaryCaller<ClientRPCRequestParams<SecretRenameMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsSecretsStat: UnaryCaller<ClientRPCRequestParams<SecretIdentifierMessage>, ClientRPCResponseResult<SecretStatMessage>>;
    vaultsSecretsTouch: DuplexCaller<ClientRPCRequestParams<SecretIdentifierMessageTagged | VaultNamesHeaderMessageTagged>, ClientRPCResponseResult<SuccessOrErrorMessageTagged>>;
    vaultsSecretsWriteFile: UnaryCaller<ClientRPCRequestParams<SecretContentMessage>, ClientRPCResponseResult<client.types.SuccessMessage>>;
    vaultsVersion: UnaryCaller<ClientRPCRequestParams<VaultsVersionMessage>, ClientRPCResponseResult<VaultsLatestVersionMessage>>;
}>>

Protected _webSocketClient

_webSocketClient: WebSocketClient

Protected fs

fs: FileSystem

Protected logger

logger: Logger

Readonly nodePath

nodePath: string

Readonly session

session: Session

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

host

localHost

localPort

nodeId

port

rpcClient

webSocketClient

Methods

addEventListener

  • Parameters

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

    Returns void

destroy

  • Destroys Polykey Client

    This will destroy the session state.

    Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

Protected handleEventWebSocketClientDestroyed

removeEventListener

  • Parameters

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

    Returns void

start

  • Parameters

    • opts: {
          fresh?: boolean;
          host: string;
          nodeId: string | NodeId;
          options?: {
              keepAliveIntervalTime?: number;
              keepAliveTimeoutTime?: number;
              rpcCallTimeoutTime?: number;
              rpcParserBufferSize?: number;
          };
          port: number;
      }
      • Optional fresh?: boolean
      • host: string
      • nodeId: string | NodeId
      • Optional options?: {
            keepAliveIntervalTime?: number;
            keepAliveTimeoutTime?: number;
            rpcCallTimeoutTime?: number;
            rpcParserBufferSize?: number;
        }
        • Optional keepAliveIntervalTime?: number
        • Optional keepAliveTimeoutTime?: number
        • Optional rpcCallTimeoutTime?: number
        • Optional rpcParserBufferSize?: number
      • port: number
    • Optional ctx: Partial<ContextTimedInput>

    Returns PromiseCancellable<void>

stop

  • Stops Polykey Client

    Stopping can force destruction of the websocket client. Prefer not forcing for a graceful stop. Stopping the session does not destroy the session state.

    Parameters

    • __namedParameters: {
          force?: boolean;
      } = {}
      • Optional force?: boolean

    Returns Promise<void>

Static createPolykeyClient

  • Creates a Polykey Client.

    Parameters

    • opts: {
          fresh?: boolean;
          fs?: FileSystem;
          host: string;
          logger?: Logger;
          nodeId: string | NodeId;
          options?: {
              keepAliveIntervalTime?: number;
              keepAliveTimeoutTime?: number;
              nodePath?: string;
              rpcCallTimeoutTime?: number;
              rpcMiddlewareFactory?: {};
              rpcParserBufferSize?: number;
          };
          port: number;
      }
      • Optional fresh?: boolean
      • Optional fs?: FileSystem
      • host: string
      • Optional logger?: Logger
      • nodeId: string | NodeId
      • Optional options?: {
            keepAliveIntervalTime?: number;
            keepAliveTimeoutTime?: number;
            nodePath?: string;
            rpcCallTimeoutTime?: number;
            rpcMiddlewareFactory?: {};
            rpcParserBufferSize?: number;
        }
        • Optional keepAliveIntervalTime?: number
        • Optional keepAliveTimeoutTime?: number
        • Optional nodePath?: string
        • Optional rpcCallTimeoutTime?: number
        • Optional rpcMiddlewareFactory?: {}
        • Optional rpcParserBufferSize?: number
      • port: number
    • Optional ctx: Partial<ContextTimedInput>

    Returns PromiseCancellable<PolykeyClient>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc