Description

SSH2 client and server modules written in pure JavaScript for node.js.

Development/testing is done against OpenSSH (8.7 currently).

Changes (breaking or otherwise) in v1.0.0 can be found here.

Table of Contents

• Requirements
• Installation
• Client Examples
  • Execute 'uptime' on a server
  • Start an interactive shell session
  • Send a raw HTTP request to port 80 on the server
  • Forward local connections to port 8000 on the server to us
  • Get a directory listing via SFTP
  • Connection hopping
  • Forward remote X11 connections
  • Dynamic (1:1) port forwarding using a SOCKSv5 proxy (using socksv5)
  • Make HTTP(S) connections easily using a custom http(s).Agent
  • Invoke an arbitrary subsystem (e.g. netconf)
• Server Examples
  • Password and public key authentication and non-interactive (exec) command execution
  • SFTP-only server
• Other Examples
  • Generate an SSH key
• API
  • Client
    • Client events
    • Client methods
  • Server
    • Server events
    • Server methods
    • Connection events
    • Connection methods
    • Session events
  • Channel
  • Pseudo-TTY settings
  • Terminal modes
  • HTTPAgent
    • HTTPAgent methods
  • HTTPSAgent
    • HTTPSAgent methods
  • Utilities

Requirements

• node.js -- v10.16.0 or newer
  • node v12.0.0 or newer for Ed25519 key support
• (Optional) cpu-features is set as an optional package dependency (you do not need to install it explicitly/separately from ssh2) that will be automatically built and used if possible. See the project's documentation for its own requirements.
  • This addon is currently used to help generate an optimal default cipher list

Installation

npm install ssh2

Client Examples

Execute 'uptime' on a server

1const { readFileSync } = require('fs');
2
3const { Client } = require('ssh2');
4
5const conn = new Client();
6conn.on('ready', () => {
7  console.log('Client :: ready');
8  conn.exec('uptime', (err, stream) => {
9    if (err) throw err;
10    stream.on('close', (code, signal) => {
11      console.log('Stream :: close :: code: ' + code + ', signal: ' + signal);
12      conn.end();
13    }).on('data', (data) => {
14      console.log('STDOUT: ' + data);
15    }).stderr.on('data', (data) => {
16      console.log('STDERR: ' + data);
17    });
18  });
19}).connect({
20  host: '192.168.100.100',
21  port: 22,
22  username: 'frylock',
23  privateKey: readFileSync('/path/to/my/key')
24});
25
26// example output:
27// Client :: ready
28// STDOUT:  17:41:15 up 22 days, 18:09,  1 user,  load average: 0.00, 0.01, 0.05
29//
30// Stream :: exit :: code: 0, signal: undefined
31// Stream :: close

Start an interactive shell session

1const { readFileSync } = require('fs');
2
3const { Client } = require('ssh2');
4
5const conn = new Client();
6conn.on('ready', () => {
7  console.log('Client :: ready');
8  conn.shell((err, stream) => {
9    if (err) throw err;
10    stream.on('close', () => {
11      console.log('Stream :: close');
12      conn.end();
13    }).on('data', (data) => {
14      console.log('OUTPUT: ' + data);
15    });
16    stream.end('ls -l\nexit\n');
17  });
18}).connect({
19  host: '192.168.100.100',
20  port: 22,
21  username: 'frylock',
22  privateKey: readFileSync('/path/to/my/key')
23});
24
25// example output:
26// Client :: ready
27// STDOUT: Last login: Sun Jun 15 09:37:21 2014 from 192.168.100.100
28//
29// STDOUT: ls -l
30// exit
31//
32// STDOUT: frylock@athf:~$ ls -l
33//
34// STDOUT: total 8
35//
36// STDOUT: drwxr-xr-x 2 frylock frylock 4096 Nov 18  2012 mydir
37//
38// STDOUT: -rw-r--r-- 1 frylock frylock   25 Apr 11  2013 test.txt
39//
40// STDOUT: frylock@athf:~$ exit
41//
42// STDOUT: logout
43//
44// Stream :: close

Send a raw HTTP request to port 80 on the server

1const { Client } = require('ssh2');
2
3const conn = new Client();
4conn.on('ready', () => {
5  console.log('Client :: ready');
6  conn.forwardOut('192.168.100.102', 8000, '127.0.0.1', 80, (err, stream) => {
7    if (err) throw err;
8    stream.on('close', () => {
9      console.log('TCP :: CLOSED');
10      conn.end();
11    }).on('data', (data) => {
12      console.log('TCP :: DATA: ' + data);
13    }).end([
14      'HEAD / HTTP/1.1',
15      'User-Agent: curl/7.27.0',
16      'Host: 127.0.0.1',
17      'Accept: */*',
18      'Connection: close',
19      '',
20      ''
21    ].join('\r\n'));
22  });
23}).connect({
24  host: '192.168.100.100',
25  port: 22,
26  username: 'frylock',
27  password: 'nodejsrules'
28});
29
30// example output:
31// Client :: ready
32// TCP :: DATA: HTTP/1.1 200 OK
33// Date: Thu, 15 Nov 2012 13:52:58 GMT
34// Server: Apache/2.2.22 (Ubuntu)
35// X-Powered-By: PHP/5.4.6-1ubuntu1
36// Last-Modified: Thu, 01 Jan 1970 00:00:00 GMT
37// Content-Encoding: gzip
38// Vary: Accept-Encoding
39// Connection: close
40// Content-Type: text/html; charset=UTF-8
41//
42//
43// TCP :: CLOSED

Forward local connections to port 8000 on the server to us

1const { Client } = require('ssh2');
2
3const conn = new Client();
4conn.on('ready', () => {
5  console.log('Client :: ready');
6  conn.forwardIn('127.0.0.1', 8000, (err) => {
7    if (err) throw err;
8    console.log('Listening for connections on server on port 8000!');
9  });
10}).on('tcp connection', (info, accept, reject) => {
11  console.log('TCP :: INCOMING CONNECTION:');
12  console.dir(info);
13  accept().on('close', () => {
14    console.log('TCP :: CLOSED');
15  }).on('data', (data) => {
16    console.log('TCP :: DATA: ' + data);
17  }).end([
18    'HTTP/1.1 404 Not Found',
19    'Date: Thu, 15 Nov 2012 02:07:58 GMT',
20    'Server: ForwardedConnection',
21    'Content-Length: 0',
22    'Connection: close',
23    '',
24    ''
25  ].join('\r\n'));
26}).connect({
27  host: '192.168.100.100',
28  port: 22,
29  username: 'frylock',
30  password: 'nodejsrules'
31});
32
33// example output:
34// Client :: ready
35// Listening for connections on server on port 8000!
36//  (.... then from another terminal on the server: `curl -I http://127.0.0.1:8000`)
37// TCP :: INCOMING CONNECTION: { destIP: '127.0.0.1',
38//  destPort: 8000,
39//  srcIP: '127.0.0.1',
40//  srcPort: 41969 }
41// TCP DATA: HEAD / HTTP/1.1
42// User-Agent: curl/7.27.0
43// Host: 127.0.0.1:8000
44// Accept: */*
45//
46//
47// TCP :: CLOSED

Get a directory listing via SFTP

1const { Client } = require('ssh2');
2
3const conn = new Client();
4conn.on('ready', () => {
5  console.log('Client :: ready');
6  conn.sftp((err, sftp) => {
7    if (err) throw err;
8    sftp.readdir('foo', (err, list) => {
9      if (err) throw err;
10      console.dir(list);
11      conn.end();
12    });
13  });
14}).connect({
15  host: '192.168.100.100',
16  port: 22,
17  username: 'frylock',
18  password: 'nodejsrules'
19});
20
21// example output:
22// Client :: ready
23// [ { filename: 'test.txt',
24//     longname: '-rw-r--r--    1 frylock   frylock         12 Nov 18 11:05 test.txt',
25//     attrs:
26//      { size: 12,
27//        uid: 1000,
28//        gid: 1000,
29//        mode: 33188,
30//        atime: 1353254750,
31//        mtime: 1353254744 } },
32//   { filename: 'mydir',
33//     longname: 'drwxr-xr-x    2 frylock   frylock       4096 Nov 18 15:03 mydir',
34//     attrs:
35//      { size: 1048576,
36//        uid: 1000,
37//        gid: 1000,
38//        mode: 16877,
39//        atime: 1353269007,
40//        mtime: 1353269007 } } ]

Connection hopping

1const { Client } = require('ssh2');
2
3const conn1 = new Client();
4const conn2 = new Client();
5
6// Checks uptime on 10.1.1.40 via 192.168.1.1
7
8conn1.on('ready', () => {
9  console.log('FIRST :: connection ready');
10  // Alternatively, you could use something like netcat or socat with exec()
11  // instead of forwardOut(), depending on what the server allows
12  conn1.forwardOut('127.0.0.1', 12345, '10.1.1.40', 22, (err, stream) => {
13    if (err) {
14      console.log('FIRST :: forwardOut error: ' + err);
15      return conn1.end();
16    }
17    conn2.connect({
18      sock: stream,
19      username: 'user2',
20      password: 'password2',
21    });
22  });
23}).connect({
24  host: '192.168.1.1',
25  username: 'user1',
26  password: 'password1',
27});
28
29conn2.on('ready', () => {
30  // This connection is the one to 10.1.1.40
31
32  console.log('SECOND :: connection ready');
33  conn2.exec('uptime', (err, stream) => {
34    if (err) {
35      console.log('SECOND :: exec error: ' + err);
36      return conn1.end();
37    }
38    stream.on('close', () => {
39      conn1.end(); // close parent (and this) connection
40    }).on('data', (data) => {
41      console.log(data.toString());
42    });
43  });
44});

Forward remote X11 connections

1const { Socket } = require('net');
2
3const { Client } = require('ssh2');
4
5const conn = new Client();
6
7conn.on('x11', (info, accept, reject) => {
8  const xserversock = new net.Socket();
9  xserversock.on('connect', () => {
10    const xclientsock = accept();
11    xclientsock.pipe(xserversock).pipe(xclientsock);
12  });
13  // connects to localhost:0.0
14  xserversock.connect(6000, 'localhost');
15});
16
17conn.on('ready', () => {
18  conn.exec('xeyes', { x11: true }, (err, stream) => {
19    if (err) throw err;
20    let code = 0;
21    stream.on('close', () => {
22      if (code !== 0)
23        console.log('Do you have X11 forwarding enabled on your SSH server?');
24      conn.end();
25    }).on('exit', (exitcode) => {
26      code = exitcode;
27    });
28  });
29}).connect({
30  host: '192.168.1.1',
31  username: 'foo',
32  password: 'bar'
33});

Dynamic (1:1) port forwarding using a SOCKSv5 proxy (using socksv5)

1const socks = require('socksv5');
2const { Client } = require('ssh2');
3
4const sshConfig = {
5  host: '192.168.100.1',
6  port: 22,
7  username: 'nodejs',
8  password: 'rules'
9};
10
11socks.createServer((info, accept, deny) => {
12  // NOTE: you could just use one ssh2 client connection for all forwards, but
13  // you could run into server-imposed limits if you have too many forwards open
14  // at any given time
15  const conn = new Client();
16  conn.on('ready', () => {
17    conn.forwardOut(info.srcAddr,
18                    info.srcPort,
19                    info.dstAddr,
20                    info.dstPort,
21                    (err, stream) => {
22      if (err) {
23        conn.end();
24        return deny();
25      }
26
27      const clientSocket = accept(true);
28      if (clientSocket) {
29        stream.pipe(clientSocket).pipe(stream).on('close', () => {
30          conn.end();
31        });
32      } else {
33        conn.end();
34      }
35    });
36  }).on('error', (err) => {
37    deny();
38  }).connect(sshConfig);
39}).listen(1080, 'localhost', () => {
40  console.log('SOCKSv5 proxy server started on port 1080');
41}).useAuth(socks.auth.None());
42
43// test with cURL:
44//   curl -i --socks5 localhost:1080 google.com

Make HTTP(S) connections easily using a custom http(s).Agent

1const http = require('http');
2
3const { Client, HTTPAgent, HTTPSAgent } = require('ssh2');
4
5const sshConfig = {
6  host: '192.168.100.1',
7  port: 22,
8  username: 'nodejs',
9  password: 'rules'
10};
11
12// Use `HTTPSAgent` instead for an HTTPS request
13const agent = new HTTPAgent(sshConfig);
14http.get({
15  host: '192.168.200.1',
16  agent,
17  headers: { Connection: 'close' }
18}, (res) => {
19  console.log(res.statusCode);
20  console.dir(res.headers);
21  res.resume();
22});

Invoke an arbitrary subsystem

1const { Client } = require('ssh2');
2
3const xmlhello = `
4  <?xml version="1.0" encoding="UTF-8"?>
5  <hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
6    <capabilities>
7      <capability>urn:ietf:params:netconf:base:1.0</capability>
8    </capabilities>
9  </hello>]]>]]>`;
10
11const conn = new Client();
12
13conn.on('ready', () => {
14  console.log('Client :: ready');
15  conn.subsys('netconf', (err, stream) => {
16    if (err) throw err;
17    stream.on('data', (data) => {
18      console.log(data);
19    }).write(xmlhello);
20  });
21}).connect({
22  host: '1.2.3.4',
23  port: 22,
24  username: 'blargh',
25  password: 'honk'
26});

Server Examples

Password and public key authentication and non-interactive (exec) command execution

1const { timingSafeEqual } = require('crypto');
2const { readFileSync } = require('fs');
3const { inspect } = require('util');
4
5const { utils: { parseKey }, Server } = require('ssh2');
6
7const allowedUser = Buffer.from('foo');
8const allowedPassword = Buffer.from('bar');
9const allowedPubKey = parseKey(readFileSync('foo.pub'));
10
11function checkValue(input, allowed) {
12  const autoReject = (input.length !== allowed.length);
13  if (autoReject) {
14    // Prevent leaking length information by always making a comparison with the
15    // same input when lengths don't match what we expect ...
16    allowed = input;
17  }
18  const isMatch = timingSafeEqual(input, allowed);
19  return (!autoReject && isMatch);
20}
21
22new Server({
23  hostKeys: [readFileSync('host.key')]
24}, (client) => {
25  console.log('Client connected!');
26
27  client.on('authentication', (ctx) => {
28    let allowed = true;
29    if (!checkValue(Buffer.from(ctx.username), allowedUser))
30      allowed = false;
31
32    switch (ctx.method) {
33      case 'password':
34        if (!checkValue(Buffer.from(ctx.password), allowedPassword))
35          return ctx.reject();
36        break;
37      case 'publickey':
38        if (ctx.key.algo !== allowedPubKey.type
39            || !checkValue(ctx.key.data, allowedPubKey.getPublicSSH())
40            || (ctx.signature && allowedPubKey.verify(ctx.blob, ctx.signature, ctx.hashAlgo) !== true)) {
41          return ctx.reject();
42        }
43        break;
44      default:
45        return ctx.reject();
46    }
47
48    if (allowed)
49      ctx.accept();
50    else
51      ctx.reject();
52  }).on('ready', () => {
53    console.log('Client authenticated!');
54
55    client.on('session', (accept, reject) => {
56      const session = accept();
57      session.once('exec', (accept, reject, info) => {
58        console.log('Client wants to execute: ' + inspect(info.command));
59        const stream = accept();
60        stream.stderr.write('Oh no, the dreaded errors!\n');
61        stream.write('Just kidding about the errors!\n');
62        stream.exit(0);
63        stream.end();
64      });
65    });
66  }).on('close', () => {
67    console.log('Client disconnected');
68  });
69}).listen(0, '127.0.0.1', function() {
70  console.log('Listening on port ' + this.address().port);
71});

SFTP-only server

1const { timingSafeEqual } = require('crypto');
2const { readFileSync } = require('fs');
3const { inspect } = require('util');
4
5const {
6  Server,
7  sftp: {
8    OPEN_MODE,
9    STATUS_CODE,
10  },
11} = require('ssh2');
12
13const allowedUser = Buffer.from('foo');
14const allowedPassword = Buffer.from('bar');
15
16function checkValue(input, allowed) {
17  const autoReject = (input.length !== allowed.length);
18  if (autoReject) {
19    // Prevent leaking length information by always making a comparison with the
20    // same input when lengths don't match what we expect ...
21    allowed = input;
22  }
23  const isMatch = timingSafeEqual(input, allowed);
24  return (!autoReject && isMatch);
25}
26
27// This simple SFTP server implements file uploading where the contents get
28// ignored ...
29
30new ssh2.Server({
31  hostKeys: [readFileSync('host.key')]
32}, (client) => {
33  console.log('Client connected!');
34
35  client.on('authentication', (ctx) => {
36    let allowed = true;
37    if (!checkValue(Buffer.from(ctx.username), allowedUser))
38      allowed = false;
39
40    switch (ctx.method) {
41      case 'password':
42        if (!checkValue(Buffer.from(ctx.password), allowedPassword))
43          return ctx.reject();
44        break;
45      default:
46        return ctx.reject();
47    }
48
49    if (allowed)
50      ctx.accept();
51    else
52      ctx.reject();
53  }).on('ready', () => {
54    console.log('Client authenticated!');
55
56    client.on('session', (accept, reject) => {
57      const session = accept();
58      session.on('sftp', (accept, reject) => {
59        console.log('Client SFTP session');
60        const openFiles = new Map();
61        let handleCount = 0;
62        const sftp = accept();
63        sftp.on('OPEN', (reqid, filename, flags, attrs) => {
64          // Only allow opening /tmp/foo.txt for writing
65          if (filename !== '/tmp/foo.txt' || !(flags & OPEN_MODE.WRITE))
66            return sftp.status(reqid, STATUS_CODE.FAILURE);
67
68          // Create a fake handle to return to the client, this could easily
69          // be a real file descriptor number for example if actually opening
70          // a file on disk
71          const handle = Buffer.alloc(4);
72          openFiles.set(handleCount, true);
73          handle.writeUInt32BE(handleCount++, 0);
74
75          console.log('Opening file for write')
76          sftp.handle(reqid, handle);
77        }).on('WRITE', (reqid, handle, offset, data) => {
78          if (handle.length !== 4
79              || !openFiles.has(handle.readUInt32BE(0))) {
80            return sftp.status(reqid, STATUS_CODE.FAILURE);
81          }
82
83          // Fake the write operation
84          sftp.status(reqid, STATUS_CODE.OK);
85
86          console.log('Write to file at offset ${offset}: ${inspect(data)}');
87        }).on('CLOSE', (reqid, handle) => {
88          let fnum;
89          if (handle.length !== 4
90              || !openFiles.has(fnum = handle.readUInt32BE(0))) {
91            return sftp.status(reqid, STATUS_CODE.FAILURE);
92          }
93
94          console.log('Closing file');
95          openFiles.delete(fnum);
96
97          sftp.status(reqid, STATUS_CODE.OK);
98        });
99      });
100    });
101  }).on('close', () => {
102    console.log('Client disconnected');
103  });
104}).listen(0, '127.0.0.1', function() {
105  console.log('Listening on port ' + this.address().port);
106});

Other Examples

Generate an SSH key

1const { utils: { generateKeyPair, generateKeyPairSync } } = require('ssh2');
2
3// Generate unencrypted ED25519 SSH key synchronously
4let keys = generateKeyPairSync('ed25519');
5// ... use `keys.public` and `keys.private`
6
7// Generate unencrypted ECDSA SSH key synchronously with a comment set
8keys = generateKeyPairSync('ecdsa', { bits: 256, comment: 'node.js rules!' });
9// ... use `keys.public` and `keys.private`
10
11// Generate encrypted RSA SSH key asynchronously
12generateKeyPair(
13  'rsa',
14  { bits: 2048, passphrase: 'foobarbaz', cipher: 'aes256-cbc' },
15  (err, keys) => {
16    if (err) throw err;
17    // ... use `keys.public` and `keys.private`
18  }
19);

You can find more examples in the examples directory of this repository.

API

require('ssh2').Client is the Client constructor.

require('ssh2').Server is the Server constructor.

require('ssh2').utils is an object containing some useful utilities.

require('ssh2').HTTPAgent is an http.Agent constructor.

require('ssh2').HTTPSAgent is an https.Agent constructor. Its API is the same as HTTPAgent except it's for HTTPS connections.

Agent-related

require('ssh2').AgentProtocol is a Duplex stream class that aids in communicating over the OpenSSH agent protocol.

require('ssh2').BaseAgent is a base class for creating custom authentication agents.

require('ssh2').createAgent is a helper function that creates a new agent instance using the same logic as the agent configuration option: if the platform is Windows and it's the value "pageant", it creates a PageantAgent, otherwise if it's not a path to a Windows pipe it creates a CygwinAgent. In all other cases, it creates an OpenSSHAgent.

require('ssh2').CygwinAgent is an agent class implementation that communicates with agents in a Cygwin environment.

require('ssh2').OpenSSHAgent is an agent class implementation that communicates with OpenSSH agents over a UNIX socket.

require('ssh2').PageantAgent is an agent class implementation that communicates with Pageant agent processes.

Client

Client events

• banner(< string >message, < string >language) - A notice was sent by the server upon connection.

• change password(< string >prompt, < function >done) - If using password-based user authentication, the server has requested that the user's password be changed. Call done with the new password.

• close() - The socket was closed.

• end() - The socket was disconnected.

• error(< Error >err) - An error occurred. A 'level' property indicates 'client-socket' for socket-level errors and 'client-ssh' for SSH disconnection messages. In the case of 'client-ssh' messages, there may be a 'description' property that provides more detail.

• handshake(< object >negotiated) - Emitted when a handshake has completed (either initial or rekey). negotiated contains the negotiated details of the handshake and is of the form:

1    // In this particular case `mac` is empty because there is no separate MAC
2    // because it's integrated into AES in GCM mode
3    { kex: 'ecdh-sha2-nistp256',
4      srvHostKey: 'rsa-sha2-512',
5      cs: { // Client to server algorithms
6        cipher: 'aes128-gcm',
7        mac: '',
8        compress: 'none',
9        lang: ''
10      },
11      sc: { // Server to client algorithms
12        cipher: 'aes128-gcm',
13        mac: '',
14        compress: 'none',
15        lang: ''
16      }
17    }

• hostkeys(< array >keys) - Emitted when the server announces its available host keys. keys is the list of parsed (using parseKey()) host public keys.

• keyboard-interactive(< string >name, < string >instructions, < string >instructionsLang, < array >prompts, < function >finish) - The server is asking for replies to the given prompts for keyboard-interactive user authentication. name is generally what you'd use as a window title (for GUI apps). prompts is an array of { prompt: 'Password: ', echo: false } style objects (here echo indicates whether user input should be displayed on the screen). The answers for all prompts must be provided as an array of strings and passed to finish when you are ready to continue. Note: It's possible for the server to come back and ask more questions.

• ready() - Authentication was successful.

• rekey() - Emitted when a rekeying operation has completed (either client or server-initiated).

• tcp connection(< object >details, < function >accept, < function >reject) - An incoming forwarded TCP connection is being requested. Calling accept accepts the connection and returns a Channel object. Calling reject rejects the connection and no further action is needed. details contains:

  • destIP - string - The remote IP the connection was received on (given in earlier call to forwardIn()).

  • destPort - integer - The remote port the connection was received on (given in earlier call to forwardIn()).

  • srcIP - string - The originating IP of the connection.

  • srcPort - integer - The originating port of the connection.

• unix connection(< object >details, < function >accept, < function >reject) - An incoming forwarded UNIX socket connection is being requested. Calling accept accepts the connection and returns a Channel object. Calling reject rejects the connection and no further action is needed. details contains:

  • socketPath - string - The originating UNIX socket path of the connection.

• x11(< object >details, < function >accept, < function >reject) - An incoming X11 connection is being requested. Calling accept accepts the connection and returns a Channel object. Calling reject rejects the connection and no further action is needed. details contains:

  • srcIP - string - The originating IP of the connection.

  • srcPort - integer - The originating port of the connection.

Client methods

• (constructor)() - Creates and returns a new Client instance.

• connect(< object >config) - (void) - Attempts a connection to a server using the information given in config:

  • agent - string - Path to ssh-agent's UNIX socket for ssh-agent-based user authentication. Windows users: set to 'pageant' for authenticating with Pageant or (actual) path to a cygwin "UNIX socket." Default: (none)

  • agentForward - boolean - Set to true to use OpenSSH agent forwarding (auth-agent@openssh.com) for the life of the connection. agent must also be set to use this feature. Default: false

  • algorithms - object - This option allows you to explicitly override the default transport layer algorithms used for the connection. The value for each category must either be an array of valid algorithm names to set an exact list (with the most preferable first) or an object containing append, prepend, and/or remove properties that each contain an array of algorithm names or RegExps to match to adjust default lists for each category. Valid keys:

    • cipher - mixed - Ciphers.

      • Default list (in order from most to least preferable):
        • chacha20-poly1305@openssh.com (priority of chacha20-poly1305 may vary depending upon CPU and/or optional binding availability)
        • aes128-gcm
        • aes128-gcm@openssh.com
        • aes256-gcm
        • aes256-gcm@openssh.com
        • aes128-ctr
        • aes192-ctr
        • aes256-ctr
      • Other supported names:
        • 3des-cbc
        • aes256-cbc
        • aes192-cbc
        • aes128-cbc
        • arcfour256
        • arcfour128
        • arcfour
        • blowfish-cbc
        • cast128-cbc

    • compress - mixed - Compression algorithms.

      • Default list (in order from most to least preferable):
        • none
        • zlib@openssh.com
        • zlib
      • Other supported names:

    • hmac - mixed - (H)MAC algorithms.

      • Default list (in order from most to least preferable):
        • hmac-sha2-256-etm@openssh.com
        • hmac-sha2-512-etm@openssh.com
        • hmac-sha1-etm@openssh.com
        • hmac-sha2-256
        • hmac-sha2-512
        • hmac-sha1
      • Other supported names:
        • hmac-md5
        • hmac-sha2-256-96
        • hmac-sha2-512-96
        • hmac-ripemd160
        • hmac-sha1-96
        • hmac-md5-96

    • kex - mixed - Key exchange algorithms.

      • Default list (in order from most to least preferable):
        • curve25519-sha256 (node v14.0.0+)
        • curve25519-sha256@libssh.org (node v14.0.0+)
        • ecdh-sha2-nistp256
        • ecdh-sha2-nistp384
        • ecdh-sha2-nistp521
        • diffie-hellman-group-exchange-sha256
        • diffie-hellman-group14-sha256
        • diffie-hellman-group15-sha512
        • diffie-hellman-group16-sha512
        • diffie-hellman-group17-sha512
        • diffie-hellman-group18-sha512
      • Other supported names:
        • diffie-hellman-group-exchange-sha1
        • diffie-hellman-group14-sha1
        • diffie-hellman-group1-sha1

    • serverHostKey - mixed - Server host key formats.

      • Default list (in order from most to least preferable):
        • ssh-ed25519 (node v12.0.0+)
        • ecdsa-sha2-nistp256
        • ecdsa-sha2-nistp384
        • ecdsa-sha2-nistp521
        • rsa-sha2-512
        • rsa-sha2-256
        • ssh-rsa
      • Other supported names:
        • ssh-dss

  • authHandler - mixed - Must be an array of objects as described below, an array of strings containing valid authentication method names (username and credentials are pulled from the object passed to connect()), or a function with parameters (methodsLeft, partialSuccess, callback) where methodsLeft and partialSuccess are null on the first authentication attempt, otherwise are an array and boolean respectively. Return or call callback() with either the name of the authentication method or an object containing the method name along with method-specific details to try next (return/pass false to signal no more methods to try). Valid method names are: 'none', 'password', 'publickey', 'agent', 'keyboard-interactive', 'hostbased'. Default: function that follows a set method order: None -> Password -> Private Key -> Agent (-> keyboard-interactive if tryKeyboard is true) -> Hostbased

    • When returning or calling callback() with an object, it can take one of the following forms:

      1{
      2  type: 'none',
      3  username: 'foo',
      4}

      1{
      2  type: 'password'
      3  username: 'foo',
      4  password: 'bar',
      5}

      1{
      2  type: 'publickey'
      3  username: 'foo',
      4  // Can be a string, Buffer, or parsed key containing a private key
      5  key: ...,
      6  // `passphrase` only required for encrypted keys
      7  passphrase: ...,
      8}

      1{
      2  type: 'hostbased'
      3  username: 'foo',
      4  localHostname: 'baz',
      5  localUsername: 'quux',
      6  // Can be a string, Buffer, or parsed key containing a private key
      7  key: ...,
      8  // `passphrase` only required for encrypted keys
      9  passphrase: ...,
      10}

      1{
      2  type: 'agent'
      3  username: 'foo',
      4  // Can be a string that is interpreted exactly like the `agent`
      5  // connection config option or can be a custom agent
      6  // object/instance that extends and implements `BaseAgent`
      7  agent: ...,
      8}

      1{
      2  type: 'keyboard-interactive'
      3  username: 'foo',
      4  // This works exactly the same way as a 'keyboard-interactive'
      5  // Client event handler
      6  prompt: (name, instructions, instructionsLang, prompts, finish) => {
      7    // ...
      8  },
      9}

  • debug - function - Set this to a function that receives a single string argument to get detailed (local) debug information. Default: (none)

  • forceIPv4 - boolean - Only connect via resolved IPv4 address for host. Default: false

  • forceIPv6 - boolean - Only connect via resolved IPv6 address for host. Default: false

  • host - string - Hostname or IP address of the server. Default: 'localhost'

  • hostHash - string - Any valid hash algorithm supported by node. The host's key is hashed using this algorithm and passed to the hostVerifier function as a hex string. Default: (none)

  • hostVerifier - function - Function with parameters (hashedKey[, callback]) where hashedKey is a string hex hash of the host's key for verification purposes. Return true to continue with the handshake or false to reject and disconnect, or call callback() with true or false if you need to perform asynchronous verification. Default: (auto-accept if hostVerifier is not set)

  • keepaliveCountMax - integer - How many consecutive, unanswered SSH-level keepalive packets that can be sent to the server before disconnection (similar to OpenSSH's ServerAliveCountMax config option). Default: 3

  • keepaliveInterval - integer - How often (in milliseconds) to send SSH-level keepalive packets to the server (in a similar way as OpenSSH's ServerAliveInterval config option). Set to 0 to disable. Default: 0

  • localAddress - string - IP address of the network interface to use to connect to the server. Default: (none -- determined by OS)

  • localHostname - string - Along with localUsername and privateKey, set this to a non-empty string for hostbased user authentication. Default: (none)

  • localPort - string - The local port number to connect from. Default: (none -- determined by OS)

  • localUsername - string - Along with localHostname and privateKey, set this to a non-empty string for hostbased user authentication. Default: (none)

  • passphrase - string - For an encrypted privateKey, this is the passphrase used to decrypt it. Default: (none)

  • password - string - Password for password-based user authentication. Default: (none)

  • port - integer - Port number of the server. Default: 22

  • privateKey - mixed - Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format). Default: (none)

  • readyTimeout - integer - How long (in milliseconds) to wait for the SSH handshake to complete. Default: 20000

  • sock - ReadableStream - A ReadableStream to use for communicating with the server instead of creating and using a new TCP connection (useful for connection hopping).

  • strictVendor - boolean - Performs a strict server vendor check before sending vendor-specific requests, etc. (e.g. check for OpenSSH server when using openssh_noMoreSessions()) Default: true

  • tryKeyboard - boolean - Try keyboard-interactive user authentication if primary user authentication method fails. If you set this to true, you need to handle the keyboard-interactive event. Default: false

  • username - string - Username for authentication. Default: (none)

• end() - (void) - Disconnects the socket.

• exec(< string >command[, < object >options], < function >callback) - (void) - Executes command on the server. callback has 2 parameters: < Error >err, < Channel >stream. Valid options properties are:

  • env - object - An environment to use for the execution of the command.

  • pty - mixed - Set to true to allocate a pseudo-tty with defaults, or an object containing specific pseudo-tty settings (see 'Pseudo-TTY settings'). Setting up a pseudo-tty can be useful when working with remote processes that expect input from an actual terminal (e.g. sudo's password prompt).

  • x11 - mixed - Set to true to use defaults below, set to a number to specify a specific screen number, or an object with the following valid properties:

    • cookie - mixed - The authentication cookie. Can be a hex string or a Buffer containing the raw cookie value (which will be converted to a hex string). Default: (random 16 byte value)

    • protocol - string - The authentication protocol name. Default: 'MIT-MAGIC-COOKIE-1'

    • screen - number - Screen number to use Default: 0

    • single - boolean - Allow just a single connection? Default: false

• forwardIn(< string >remoteAddr, < integer >remotePort, < function >callback) - (void) - Bind to remoteAddr on remotePort on the server and forward incoming TCP connections. callback has 2 parameters: < Error >err, < integer >port (port is the assigned port number if remotePort was 0). Here are some special values for remoteAddr and their associated binding behaviors:

  • '' - Connections are to be accepted on all protocol families supported by the server.

  • '0.0.0.0' - Listen on all IPv4 addresses.

  • '::' - Listen on all IPv6 addresses.

  • 'localhost' - Listen on all protocol families supported by the server on loopback addresses only.

  • '127.0.0.1' and '::1' - Listen on the loopback interfaces for IPv4 and IPv6, respectively.

• forwardOut(< string >srcIP, < integer >srcPort, < string >dstIP, < integer >dstPort, < function >callback) - (void) - Open a connection with srcIP and srcPort as the originating address and port and dstIP and dstPort as the remote destination address and port. callback has 2 parameters: < Error >err, < Channel >stream.

• openssh_forwardInStreamLocal(< string >socketPath, < function >callback) - (void) - OpenSSH extension that binds to a UNIX domain socket at socketPath on the server and forwards incoming connections. callback has 1 parameter: < Error >err.

• openssh_forwardOutStreamLocal(< string >socketPath, < function >callback) - (void) - OpenSSH extension that opens a connection to a UNIX domain socket at socketPath on the server. callback has 2 parameters: < Error >err, < Channel >stream.

• openssh_noMoreSessions(< function >callback) - (void) - OpenSSH extension that sends a request to reject any new sessions (e.g. exec, shell, sftp, subsys) for this connection. callback has 1 parameter: < Error >err.

• openssh_unforwardInStreamLocal(< string >socketPath, < function >callback) - (void) - OpenSSH extension that unbinds from a UNIX domain socket at socketPath on the server and stops forwarding incoming connections. callback has 1 parameter: < Error >err.

• rekey([< function >callback]) - (void) - Initiates a rekey with the server. If callback is supplied, it is added as a one-time handler for the rekey event.

• setNoDelay([< boolean >noDelay]) - Client - Calls setNoDelay() on the underlying socket. Disabling Nagle's algorithm improves latency at the expense of lower throughput.

• sftp(< function >callback) - (void) - Starts an SFTP session. callback has 2 parameters: < Error >err, < SFTP >sftp. For methods available on sftp, see the SFTP client documentation.

• shell([[< mixed >window,] < object >options]< function >callback) - (void) - Starts an interactive shell session on the server, with an optional window object containing pseudo-tty settings (see 'Pseudo-TTY settings'). If window === false, then no pseudo-tty is allocated. options supports the x11 and env options as described in exec(). callback has 2 parameters: < Error >err, < Channel >stream.

• subsys(< string >subsystem, < function >callback) - (void) - Invokes subsystem on the server. callback has 2 parameters: < Error >err, < Channel >stream.

• unforwardIn(< string >remoteAddr, < integer >remotePort, < function >callback) - (void) - Unbind from remoteAddr on remotePort on the server and stop forwarding incoming TCP connections. Until callback is called, more connections may still come in. callback has 1 parameter: < Error >err.

Server

Server events

• connection(< Connection >client, < object >info) - A new client has connected. info contains the following properties:

  • family - string - The remoteFamily of the connection.

  • header - object - Information about the client's header:

    • identRaw - string - The raw client identification string.

    • versions - object - Various version information:

      • protocol - string - The SSH protocol version (always 1.99 or 2.0).

      • software - string - The software name and version of the client.

    • comments - string - Any text that comes after the software name/version.

  Example: the identification string SSH-2.0-OpenSSH_6.6.1p1 Ubuntu-2ubuntu2 would be parsed as:

1        { identRaw: 'SSH-2.0-OpenSSH_6.6.1p1 Ubuntu-2ubuntu2',
2          version: {
3            protocol: '2.0',
4            software: 'OpenSSH_6.6.1p1'
5          },
6          comments: 'Ubuntu-2ubuntu2' }

* **ip** - _string_ - The `remoteAddress` of the connection.

* **port** - _integer_ - The `remotePort` of the connection.

Server methods

• (constructor)(< object >config[, < function >connectionListener]) - Creates and returns a new Server instance. Server instances also have the same methods/properties/events as net.Server. connectionListener if supplied, is added as a connection listener. Valid config properties:

  • algorithms - object - This option allows you to explicitly override the default transport layer algorithms used for incoming client connections. Each value must be an array of valid algorithms for that category. The order of the algorithms in the arrays are important, with the most favorable being first. For a list of valid and default algorithm names, please review the documentation for the version of ssh2 used by this module. Valid keys:

    • cipher - array - Ciphers.

    • compress - array - Compression algorithms.

    • hmac - array - (H)MAC algorithms.

    • kex - array - Key exchange algorithms.

    • serverHostKey - array - Server host key formats.

  • banner - string - A message that is sent to clients once, right before authentication begins. Default: (none)

  • debug - function - Set this to a function that receives a single string argument to get detailed (local) debug information. Default: (none)

  • greeting - string - A message that is sent to clients immediately upon connection, before handshaking begins. Note: Most clients usually ignore this. Default: (none)

  • highWaterMark - integer - This is the highWaterMark to use for the parser stream. Default: 32 * 1024

  • hostKeys - array - An array of either Buffers/strings that contain host private keys or objects in the format of { key: <Buffer/string>, passphrase: <string> } for encrypted private keys. (Required) Default: (none)

  • ident - string - A custom server software name/version identifier. Default: 'ssh2js' + moduleVersion + 'srv'

• injectSocket(< DuplexStream >socket) - Injects a bidirectional stream as though it were a TCP socket connection. Additionally, socket should include net.Socket-like properties to ensure the best compatibility (e.g. socket.remoteAddress, socket.remotePort, socket.remoteFamily).

Connection events

• authentication(< AuthContext >ctx) - The client has requested authentication. ctx.username contains the client username, ctx.method contains the requested authentication method, and ctx.accept() and ctx.reject([< Array >authMethodsLeft[, < Boolean >isPartialSuccess]]) are used to accept or reject the authentication request respectively. 'abort' is emitted if the client aborts the authentication request. Other properties/methods available on ctx depends on the ctx.method of authentication the client has requested:

  • hostbased:

    • blob - Buffer - This contains the data to be verified that is passed to (along with the signature) key.verify() where key is a public key parsed with parseKey().

    • key - object - Contains information about the public key sent by the client:

      • algo - string - The name of the key algorithm (e.g. ssh-rsa).

      • data - Buffer - The actual key data.

    • localHostname - string - The local hostname provided by the client.

    • localUsername - string - The local username provided by the client.

    • signature - Buffer - This contains a signature to be verified that is passed to (along with the blob) key.verify() where key is a public key parsed with parseKey().

    • hashAlgo - mixed - This is either undefined or a string containing an explicit hash algorithm to be used during verification (passed to key.verify()).

  • keyboard-interactive:

    • prompt(< array >prompts[, < string >title[, < string >instructions]], < function >callback) - (void) - Send prompts to the client. prompts is an array of { prompt: 'Prompt text', echo: true } objects (prompt being the prompt text and echo indicating whether the client's response to the prompt should be echoed to their display). callback is called with (responses), where responses is an array of string responses matching up to the prompts.

    • submethods - array - A list of preferred authentication "sub-methods" sent by the client. This may be used to determine what (if any) prompts to send to the client.

  • password:

    • password - string - This is the password sent by the client.

    • requestChange(< string >prompt, < function >callback) - (void) - Sends a password change request to the client. callback is called with (newPassword), where newPassword is the new password supplied by the client. You may accept, reject, or prompt for another password change after callback is called.

  • publickey:

    • blob - mixed - If the value is undefined, the client is only checking the validity of the key. If the value is a Buffer, then this contains the data to be verified that is passed to (along with the signature) key.verify() where key is a public key parsed with parseKey().

    • key - object - Contains information about the public key sent by the client:

      • algo - string - The name of the key algorithm (e.g. ssh-rsa).

      • data - Buffer - The actual key data.

    • signature - mixed - If the value is undefined, the client is only checking the validity of the key. If the value is a Buffer, then this contains a signature to be verified that is passed to (along with the blob) key.verify() where key is a public key parsed with parseKey().

    • hashAlgo - mixed - This is either undefined or a string containing an explicit hash algorithm to be used during verification (passed to key.verify()).

• close() - The client socket was closed.

• end() - The client socket disconnected.

• error(< Error >err) - An error occurred.

• handshake(< object >negotiated) - Emitted when a handshake has completed (either initial or rekey). negotiated contains the negotiated details of the handshake and is of the form:

1    // In this particular case `mac` is empty because there is no separate MAC
2    // because it's integrated into AES in GCM mode
3    { kex: 'ecdh-sha2-nistp256',
4      srvHostKey: 'rsa-sha2-512',
5      cs: { // Client to server algorithms
6        cipher: 'aes128-gcm',
7        mac: '',
8        compress: 'none',
9        lang: ''
10      },
11      sc: { // Server to client algorithms
12        cipher: 'aes128-gcm',
13        mac: '',
14        compress: 'none',
15        lang: ''
16      }
17    }

• openssh.streamlocal(< function >accept, < function >reject, < object >info) - Emitted when the client has requested a connection to a UNIX domain socket. accept() returns a new Channel instance representing the connection. info contains:

  • socketPath - string - Destination socket path of outgoing connection.

• ready() - Emitted when the client has been successfully authenticated.

• rekey() - Emitted when a rekeying operation has completed (either client or server-initiated).

• request(< mixed >accept, < mixed >reject, < string >name, < object >info) - Emitted when the client has sent a global request for name (e.g. tcpip-forward or cancel-tcpip-forward). accept and reject are functions if the client requested a response. If bindPort === 0, you should pass the chosen port to accept() so that the client will know what port was bound. info contains additional details about the request:

  • cancel-tcpip-forward and tcpip-forward:

    • bindAddr - string - The IP address to start/stop binding to.

    • bindPort - integer - The port to start/stop binding to.

  • cancel-streamlocal-forward@openssh.com and streamlocal-forward@openssh.com:

    • socketPath - string - The socket path to start/stop binding to.

• session(< function >accept, < function >reject) - Emitted when the client has requested a new session. Sessions are used to start interactive shells, execute commands, request X11 forwarding, etc. accept() returns a new Session instance.

• tcpip(< function >accept, < function >reject, < object >info) - Emitted when the client has requested an outbound (TCP) connection. accept() returns a new Channel instance representing the connection. info contains:

  • destIP - string - Destination IP address of outgoing connection.

  • destPort - string - Destination port of outgoing connection.

  • srcIP - string - Source IP address of outgoing connection.

  • srcPort - string - Source port of outgoing connection.

Connection methods

• end() - (void) - Closes the client connection.

• forwardOut(< string >boundAddr, < integer >boundPort, < string >remoteAddr, < integer >remotePort, < function >callback) - (void) - Alert the client of an incoming TCP connection on boundAddr on port boundPort from remoteAddr on port remotePort. callback has 2 parameters: < Error >err, < Channel >stream.

• openssh_forwardOutStreamLocal(< string >socketPath, < function >callback) - (void) - Alert the client of an incoming UNIX domain socket connection on socketPath. callback has 2 parameters: < Error >err, < Channel >stream.

• rekey([< function >callback]) - (void) - Initiates a rekey with the client. If callback is supplied, it is added as a one-time handler for the rekey event.

• setNoDelay([< boolean >noDelay]) - Connection - Calls setNoDelay() on the underlying socket. Disabling Nagle's algorithm improves latency at the expense of lower throughput.

• x11(< string >originAddr, < integer >originPort, < function >callback) - (void) - Alert the client of an incoming X11 client connection from originAddr on port originPort. callback has 2 parameters: < Error >err, < Channel >stream.

Session events

• auth-agent(< mixed >accept, < mixed >reject) - The client has requested incoming ssh-agent requests be forwarded to them. accept and reject are functions if the client requested a response.

• close() - The session was closed.

• env(< mixed >accept, < mixed >reject, < object >info) - The client requested an environment variable to be set for this session. accept and reject are functions if the client requested a response. info has these properties:

  • key - string - The environment variable's name.

  • value - string - The environment variable's value.

• exec(< mixed >accept, < mixed >reject, < object >info) - The client has requested execution of a command string. accept and reject are functions if the client requested a response. accept() returns a Channel for the command execution. info has these properties:

  • command - string - The command line to be executed.

• pty(< mixed >accept, < mixed >reject, < object >info) - The client requested allocation of a pseudo-TTY for this session. accept and reject are functions if the client requested a response. info has these properties:

  • term - string - The terminal type for the pseudo-TTY.

  • cols - integer - The number of columns for the pseudo-TTY.

  • height - integer - The height of the pseudo-TTY in pixels.

  • modes - object - Contains the requested terminal modes of the pseudo-TTY keyed on the mode name with the value being the mode argument. (See the table at the end for valid names).

  • rows - integer - The number of rows for the pseudo-TTY.

  • width - integer - The width of the pseudo-TTY in pixels.

• sftp(< mixed >accept, < mixed >reject) - The client has requested the SFTP subsystem. accept and reject are functions if the client requested a response. accept() returns an SFTP instance in server mode (see the SFTP documentation for details). info has these properties:

• shell(< mixed >accept, < mixed >reject) - The client has requested an interactive shell. accept and reject are functions if the client requested a response. accept() returns a Channel for the interactive shell.

• signal(< mixed >accept, < mixed >reject, < object >info) - The client has sent a signal. accept and reject are functions if the client requested a response. info has these properties:

  • name - string - The signal name (e.g. SIGUSR1).

• subsystem(< mixed >accept, < mixed >reject, < object >info) - The client has requested an arbitrary subsystem. accept and reject are functions if the client requested a response. accept() returns a Channel for the subsystem. info has these properties:

  • name - string - The name of the subsystem.

• window-change(< mixed >accept, < mixed >reject, < object >info) - The client reported a change in window dimensions during this session. accept and reject are functions if the client requested a response. info has these properties:

  • cols - integer - The new number of columns for the client window.

  • height - integer - The new height of the client window in pixels.

  • rows - integer - The new number of rows for the client window.

  • width - integer - The new width of the client window in pixels.

• x11(< mixed >accept, < mixed >reject, < object >info) - The client requested X11 forwarding. accept and reject are functions if the client requested a response. info has these properties:

  • cookie - string - The X11 authentication cookie encoded in hexadecimal.

  • protocol - string - The name of the X11 authentication method used (e.g. MIT-MAGIC-COOKIE-1).

  • screen - integer - The screen number to forward X11 connections for.

  • single - boolean - true if only a single connection should be forwarded.

Channel

This is a normal streams2 Duplex Stream (used both by clients and servers), with the following changes:

• A boolean property allowHalfOpen exists and behaves similarly to the property of the same name for net.Socket. When the stream's end() is called, if allowHalfOpen is true, only EOF will be sent (the server can still send data if they have not already sent EOF). The default value for this property is true.

• A close event is emitted once the channel is completely closed on both the client and server.

• Client-specific:

  • For exec():

    • An exit event may (the SSH2 spec says it is optional) be emitted when the process finishes. If the process finished normally, the process's return value is passed to the exit callback. If the process was interrupted by a signal, the following are passed to the exit callback: null, < string >signalName, < boolean >didCoreDump, < string >description.

    • If there was an exit event, the close event will be passed the same arguments for convenience.

    • A stderr property contains a Readable stream that represents output from stderr.

  • For exec() and shell():

    • The readable side represents stdout and the writable side represents stdin.

    • setWindow(< integer >rows, < integer >cols, < integer >height, < integer >width) - (void) - Lets the server know that the local terminal window has been resized. The meaning of these arguments are described in the 'Pseudo-TTY settings' section.

    • signal(< string >signalName) - (void) - Sends a POSIX signal to the current process on the server. Valid signal names are: 'ABRT', 'ALRM', 'FPE', 'HUP', 'ILL', 'INT', 'KILL', 'PIPE', 'QUIT', 'SEGV', 'TERM', 'USR1', and 'USR2'. Some server implementations may ignore this request if they do not support signals. Note: If you are trying to send SIGINT and you find signal() doesn't work, try writing '\x03' to the Channel stream instead.

• Server-specific:

  • For exec-enabled channel instances there is an additional method available that may be called right before you close the channel. It has two different signatures:

    • exit(< integer >exitCode) - (void) - Sends an exit status code to the client.

    • exit(< string >signalName[, < boolean >coreDumped[, < string >errorMsg]]) - (void) - Sends an exit status code to the client.

  • For exec and shell-enabled channel instances, channel.stderr is a writable stream.

Pseudo-TTY settings

• cols - < integer > - Number of columns. Default: 80

• height - < integer > - Height in pixels. Default: 480

• modes - < object > - An object containing Terminal Modes as keys, with each value set to each mode argument. Default: null

• rows - < integer > - Number of rows. Default: 24

• term - < string > - The value to use for $TERM. Default: 'vt100'

• width - < integer > - Width in pixels. Default: 640

rows and cols override width and height when rows and cols are non-zero.

Pixel dimensions refer to the drawable area of the window.

Zero dimension parameters are ignored.

Terminal modes

Name	Description
CS7	7 bit mode.
CS8	8 bit mode.
ECHOCTL	Echo control characters as ^(Char).
ECHO	Enable echoing.
ECHOE	Visually erase chars.
ECHOKE	Visual erase for line kill.
ECHOK	Kill character discards current line.
ECHONL	Echo NL even if ECHO is off.
ICANON	Canonicalize input lines.
ICRNL	Map CR to NL on input.
IEXTEN	Enable extensions.
IGNCR	Ignore CR on input.
IGNPAR	The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE.
IMAXBEL	Ring bell on input queue full.
INLCR	Map NL into CR on input.
INPCK	Enable checking of parity errors.
ISIG	Enable signals INTR, QUIT, [D]SUSP.
ISTRIP	Strip 8th bit off characters.
IUCLC	Translate uppercase characters to lowercase.
IXANY	Any char will restart after stop.
IXOFF	Enable input flow control.
IXON	Enable output flow control.
NOFLSH	Don't flush after interrupt.
OCRNL	Translate carriage return to newline (output).
OLCUC	Convert lowercase to uppercase.
ONLCR	Map NL to CR-NL.
ONLRET	Newline performs a carriage return (output).
ONOCR	Translate newline to carriage return-newline (output).
OPOST	Enable output processing.
PARENB	Parity enable.
PARMRK	Mark parity and framing errors.
PARODD	Odd parity, else even.
PENDIN	Retype pending input.
TOSTOP	Stop background jobs from output.
TTY_OP_ISPEED	Specifies the input baud rate in bits per second.
TTY_OP_OSPEED	Specifies the output baud rate in bits per second.
VDISCARD	Toggles the flushing of terminal output.
VDSUSP	Another suspend character.
VEOF	End-of-file character (sends EOF from the terminal).
VEOL2	Additional end-of-line character.
VEOL	End-of-line character in addition to carriage return and/or linefeed.
VERASE	Erase the character to left of the cursor.
VFLUSH	Character to flush output.
VINTR	Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems.
VKILL	Kill the current input line.
VLNEXT	Enter the next character typed literally, even if it is a special character
VQUIT	The quit character (sends SIGQUIT signal on POSIX systems).
VREPRINT	Reprints the current input line.
VSTART	Continues paused output (normally control-Q).
VSTATUS	Prints system status line (load, command, pid, etc).
VSTOP	Pauses output (normally control-S).
VSUSP	Suspends the current program.
VSWTCH	Switch to a different shell layer.
VWERASE	Erases a word left of cursor.
XCASE	Enable input and output of uppercase characters by preceding their lowercase equivalents with "".

HTTPAgent

HTTPAgent methods

• (constructor)(< object >sshConfig[, < object >agentConfig]) - Creates and returns a new http.Agent instance used to tunnel an HTTP connection over SSH. sshConfig is what is passed to client.connect() and agentOptions is passed to the http.Agent constructor.

HTTPSAgent

HTTPSAgent methods

• (constructor)(< object >sshConfig[, < object >agentConfig]) - Creates and returns a new https.Agent instance used to tunnel an HTTP connection over SSH. sshConfig is what is passed to client.connect() and agentOptions is passed to the https.Agent constructor.

Utilities

• generateKeyPair(< string >keyType[, < object >options], < function >callback) - (void) - Generates an SSH key pair of the given type. keyType may be one of 'rsa', 'ecdsa', or 'ed25519' (node.js v12+). callback has the signature (err, keys) where keys is an object containing private and public properties containing the generated SSH keys. options may contain:

  • bits - integer - For ECDSA and RSA keys, this is the key strength. For ECDSA, this is restricted to 256, 384, or 521. Default: (none)

  • cipher - string - The (SSH, not OpenSSL) cipher to use to encrypt the key. Default: (none)

  • comment - string - A comment to include in the private and public keys. Default: ''

  • format - string - The SSH key format to use. Currently only 'new' is supported, which represents the current OpenSSH key formats. Default: 'new'

  • passphrase - mixed - The desired passphrase for encrypting the key. This can either be a string or Buffer. Default: (none)

  • rounds - integer - For 'new'-formatted SSH keys, this is the number of bcrypt rounds to use when generating cipher parameters for encrypted keys. Default: 16

• generateKeyPairSync(< string >keyType[, < object >options]) - object - Generates an SSH key pair of the given type. This is a synchronous version of generateKeyPair().

• parseKey(< mixed >keyData[, < string >passphrase]) - mixed - Parses a private/public key in OpenSSH, RFC4716, or PPK format. For encrypted private keys, the key will be decrypted with the given passphrase. keyData can be a Buffer or string value containing the key contents. The returned value will be an array of objects (currently in the case of modern OpenSSH keys) or an object with these properties and methods:

  • comment - string - The comment for the key

  • equals(< mixed >otherKey) - boolean - This returns true if otherKey (a parsed or parseable key) is the same as this key. This method does not compare the keys' comments

  • getPrivatePEM() - string - This returns the PEM version of a private key

  • getPublicPEM() - string - This returns the PEM version of a public key (for either public key or derived from a private key)

  • getPublicSSH() - string - This returns the SSH version of a public key (for either public key or derived from a private key)

  • isPrivateKey() - boolean - This returns true if the key is a private key or not

  • sign(< mixed >data) - mixed - This signs the given data using this key and returns a Buffer containing the signature on success. On failure, an Error will be returned. data can be anything accepted by node's sign.update().

  • type - string - The full key type (e.g. 'ssh-rsa')

  • verify(< mixed >data, < Buffer >signature) - mixed - This verifies a signature of the given data using this key and returns true if the signature could be verified. On failure, either false will be returned or an Error will be returned upon a more critical failure. data can be anything accepted by node's verify.update().

• sftp.OPEN_MODE - OPEN_MODE

• sftp.STATUS_CODE - STATUS_CODE

• sftp.flagsToString - flagsToString()

• sftp.stringToFlags - stringToFlags()

AgentProtocol

AgentProtocol events

• identities(< opaque >request) - (Server mode only) The client has requested a list of public keys stored in the agent. Use failureReply() or getIdentitiesReply() to reply appropriately.

• sign(< opaque >request, < mixed >pubKey, < Buffer >data, < object >options) - (Server mode only) The client has requested data to be signed using the key identified by pubKey. Use failureReply() or signReply() to reply appropriately. options may contain any of:

  • hash - string - The explicitly desired hash to use when computing the signature. Currently if set, this may be either 'sha256' or 'sha512' for RSA keys.

AgentProtocol methods

• (constructor)(< boolean >isClient) - Creates and returns a new AgentProtocol instance. isClient determines whether the instance operates in client or server mode.

• failureReply(< opaque >request) - (void) - (Server mode only) Replies to the given request with a failure response.

• getIdentities(< function >callback) - (void) - (Client mode only) Requests a list of public keys from the agent. callback is passed (err, keys) where keys is a possible array of public keys for authentication.

• getIdentitiesReply(< opaque >request, < array >keys) - (void) - (Server mode only) Responds to a identities list request with the given array of keys in keys.

• sign(< mixed >pubKey, < Buffer >data, < object >options, < function >callback) - (void) - (Client mode only) Requests that the agent sign data using the key identified by pubKey. pubKey can be any parsed (using utils.parseKey()) or parseable key value. callback is passed (err, signature) where signature is a possible Buffer containing the signature for the data. options may contain any of:

  • hash - string - The explicitly desired hash to use when computing the signature. Currently if set, this may be either 'sha256' or 'sha512' for RSA keys.

• signReply(< opaque >request, < Buffer >signature) - (void) - (Server mode only) Responds to a sign request with the given signature in signature.

BaseAgent

In order to create a custom agent, your class must:

• Extend BaseAgent

• Call super() in its constructor

• Implement at least the following methods:

• getIdentities(< function >callback) - (void) - Passes (err, keys) to callback where keys is a possible array of public keys for authentication.

• sign(< mixed >pubKey, < Buffer >data, < object >options, < function >callback) - (void) - Signs data using the key identified by pubKey. pubKey can be any parsed (using utils.parseKey()) or parseable key value. callback should be passed (err, signature) where signature is a possible Buffer containing the signature for the data. options may contain any of:

  • hash - string - The explicitly desired hash to use when computing the signature. Currently if set, this may be either 'sha256' or 'sha512' for RSA keys.

Additionally your class may implement the following method in order to support agent forwarding on the client:

• getStream(< function >callback) - (void) - Passes (err, stream) to callback where stream is a possible Duplex stream to be used to communicate with your agent. You will probably want to utilize AgentProtocol as agent forwarding is an OpenSSH feature, so the stream needs to be able to transmit/receive OpenSSH agent protocol packets.

createAgent

• createAgent(< string >agentValue) - (Agent) - Creates and returns a new agent instance using the same logic as the Client's agent configuration option: if the platform is Windows and it's the value "pageant", it creates a PageantAgent, otherwise if it's not a path to a Windows pipe it creates a CygwinAgent. In all other cases, it creates an OpenSSHAgent.

CygwinAgent

CygwinAgent methods

• (constructor)(< string >socketPath) - Communicates with an agent listening at socketPath in a Cygwin environment.

OpenSSHAgent

OpenSSHAgent methods

• (constructor)(< string >socketPath) - Communicates with an OpenSSH agent listening on the UNIX socket at socketPath.

PageantAgent

PageantAgent methods

• (constructor)() - Creates a new agent instance for communicating with a running Pageant agent process.