SshAuthSession
Defined in: src/protocols/ssh/auth/SshAuthSession.ts:98
Runs SSH user authentication over an encrypted transport connection.
Call this after SshTransportConnection.connect() completes.
Returns a generator of inbound payloads for the upper (connection) layer to consume.
Resolves with an SshAuthResult on success; throws AuthenticationError on failure.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SshAuthSession(transport: SshTransportConnection): SshAuthSession;Defined in: src/protocols/ssh/auth/SshAuthSession.ts:99
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transport | SshTransportConnection |
Returns
Section titled “Returns”SshAuthSession
Methods
Section titled “Methods”authenticate()
Section titled “authenticate()”authenticate(options: SshAuthOptions): Promise<SshAuthResult>;Defined in: src/protocols/ssh/auth/SshAuthSession.ts:101
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | SshAuthOptions |
Returns
Section titled “Returns”Promise<SshAuthResult>