Class LdapClient

LDAP TLS Client over Websocket.

Hierarchy (View Summary)

AbstractTlsConnection
- LdapClient

Constructors

constructor

new LdapClient(socketProvider: TlsWebSocketProvider): LdapClient
Parameters
- socketProvider: TlsWebSocketProvider
Returns LdapClient
Inherited from AbstractTlsConnection.constructor

Properties

`Protected`socket

socket: undefined | TlsWebSocket

`Protected`reader

reader: undefined | SocketReader

`Protected`timeout

timeout: number

debugEnabled

debugEnabled: boolean

set to debug HttpClient with console.log

onVerifyTlsConnection

onVerifyTlsConnection: (socket: TlsWebSocket) => Promise<void>

Hook method for double verify a connection aber the tls connection has been established.

Type Declaration

- (socket: TlsWebSocket): Promise<void>
- Parameters
  - socket: TlsWebSocket
    the new opened tls connection.
  Returns Promise<void>

`Protected`lastErrorType

lastErrorType: LdapErrorType

`Protected`smtpExtensions

smtpExtensions: string[]

Methods

`Static`escape

escape(plainString: string): string
Escapes a string to be safely used within an LDAP Query. Replaces chars: ( ) & | = ! > < ~ * /
With the corresponding <ascii-code-in-hex>
Parameters
- plainString: string
Returns string
See
http://www.ldapexplorer.com/en/manual/109010000-ldap-filter-syntax.htm

debug

debug(...args: unknown[]): void
Parameters
- ...args: unknown[]
Returns void
Inherited from AbstractTlsConnection.debug

getReader

getReader(): SocketReader
Returns SocketReader
Inherited from AbstractTlsConnection.getReader

setTimeoutRead

setTimeoutRead(timeout: number): void
Sets the read timeout in ms
Parameters
- timeout: number
  timeout in ms
Returns void
Inherited from AbstractTlsConnection.setTimeoutRead

getSocket

getSocket(): TlsWebSocket
Returns TlsWebSocket
Inherited from AbstractTlsConnection.getSocket

getTlsCertificateChain

getTlsCertificateChain(): undefined | string
Returns a PEM string containing of the certificate chain.

Returns undefined | string
PEM string.

Inherited from AbstractTlsConnection.getTlsCertificateChain

sendCommand

sendCommand(command: string): void
Parameters
- command: string
Returns void
Inherited from AbstractTlsConnection.sendCommand

`Protected`connectTlsClient

connectTlsClient(): Promise<void>
Waits for the WASM to be loaded, then starts the connection to the WebSocket after that tries to establish a tls connections.

Returns Promise<void>
a Promise that resolves after the TLS connection is established, and rejects in case of an error

Inherited from AbstractTlsConnection.connectTlsClient

getLastErrorType

getLastErrorType(): LdapErrorType
Returns LdapErrorType
the type of the last error

connect

connect(baseDn?: string): Promise<void>
Parameters
- OptionalbaseDn: string
Returns Promise<void>

search

search(
    baseDN: string,
    searchString: string,
    searchOptions?: SearchOptions,
): Promise<SearchResponse>
Parameters
- baseDN: string
- searchString: string
- OptionalsearchOptions: SearchOptions
Returns Promise<SearchResponse>

isClosed

isClosed(): boolean
Returns boolean

closeConnection

closeConnection(): void
Returns void