Node.js postgresql connecting with ssh-tunnel proxy

nodejs-postgresql-ssh-tunnel-proxy.js

const fs = require('fs');
const os = require('os');
const tunnelSsh = require('tunnel-ssh');
const { Pool } = require('pg');

(async () => {

  /** @type {import('net').Server} */
  let tunnel;
  try {
    tunnel = await createTunnel();
  } catch (err) {
    console.error(err);
    return;
  }

  try {
    const db = connectPg();
    const { rows } = await db.query('select now()');
    console.log(rows); // [ { now: 2020-10-13T22:08:50.496Z } ]
  } catch (err) {
    console.error(err);
  } finally {
    tunnel.close();
  }

})();


/**
 * @param {number} [localPort=63334]
 * @returns {Promise<import('net').Server>}
 */
async function createTunnel(localPort = 63334) {

  /** @type {import('tunnel-ssh').Config} */
  const tunnelConfig = {
    username: 'имя пользователя на удалённом сервере',
    password: 'пароль пользователя на удалённом сервере',
    // в случае если настроен доступ по ключу
    // privateKey: fs.readFileSync(`${os.homedir()}/.ssh/id_rsa`),
    host: 'адрес удалённого сервера',
    port: 22, // порт для ssh-соединения
    dstPort: 5432, // порт postgres на удалённом сервере
    localPort: localPort, // порт postgres на локальной машине
    keepAlive: true,
    readyTimeout: 10000,
  };

  return new Promise((resolve, reject) => {

    tunnelSsh(tunnelConfig, (err, server) => {
      if (err) {
        return reject(err);
      }
      resolve(server);
    })
    .on('error', (err) => console.error('[tunnel-ssh] error:', err))
    .on('connection', () => console.log('[tunnel-ssh] connected'))
    .on('close', () => console.log('[tunnel-ssh] closed'));

  });
}

/**
 * @param {number} [localPort=63334]
 * @returns {import('pg').Pool}
 */
function connectPg(localPort = 63334) {

  /** @type {import('pg').ConnectionConfig} */
  const connectionConfig = {
    database: 'db_name',
    port: localPort, // порт, куда туннель проксирует postgres
    user: 'db_user_name',
    password: 'db_user_password'
  };

  return new Pool(connectionConfig);
}

associated ru.so question

Hi Norbornen,
I am trying to use the code you have given, I am getting error TypeError: tunnelSsh is not a function, I could not fix it, can you please suggest what could be the issue. My Node version is v18.12.1 and npm version is 8.19.2..

Thank you

with warm regards
ramki

i have the exact same error : i even used this code but still same :

const tunnel = require('tunnel-ssh');


        var server = tunnel.tunnel(config, function (error, server) {
            if (error) {
                console.log("SSH connection error: " + error);
            } else {
                console.log('SSH tunnel created successfully');
            }
            
        })```

For tunnel-ssh v5:

async function run() {
  const localPort = 63334;
  const [server, client] = await createTunnel(
    { autoClose: false },
    { port: localPort },
    {
      host: ...,
      port: 22,
      username: ...,
      password: ...,
      keepaliveInterval: 1000,
      readyTimeout: 10000,
    },
    { dstPort: 5432 }
  );

  const db = new Pool({
    database: ...,
    port: localPort,
    user: ...,
  });

  const { rows } = await db.query('select now()');
  console.log(rows);
}