React Native

Authenticate an SSH Tunnel with a Private Key

Demonstrates the Chilkat MailMan.SshAuthenticatePk method, which authenticates with the SSH server using public-key authentication after an SSH tunnel has been opened. The first argument is the SSH account name and the second is the SSH private key (an SshKey object). This example opens a tunnel, loads an OpenSSH private key, authenticates with it, and runs a POP3 operation through the tunnel.

Background: SSH public-key authentication replaces a password with a key pair: the public key is installed on the SSH server, and the client proves it holds the matching private key without ever transmitting a secret. This is the preferred method for automated systems — there is no password to embed or rotate, and the key can be revoked server-side. Chilkat reads the key with an SshKey object, which understands common formats such as OpenSSH and PuTTY.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { MailMan, SshKey } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the MailMan.SshAuthenticatePk method, which authenticates with the SSH server
  // using public-key authentication after an SSH tunnel has been opened.  The 1st argument is
  // the SSH account name and the 2nd is the SSH private key.

  const mailman = new MailMan();

  // Configure the POP3 server connection.  These connections will travel through the tunnel.
  mailman.mailHost = 'pop.example.com';
  mailman.mailPort = 995;
  mailman.popSsl = true;
  mailman.popUsername = 'user@example.com';
  mailman.popPassword = 'myPassword';

  // Open the SSH tunnel first.
  try {
    await mailman.sshOpenTunnelAsync('ssh.example.com', 22);
  } catch {
    console.log(mailman.lastErrorText);
    return;
  }

  // Load the SSH private key from an OpenSSH-format key file.
  const sshKey = new SshKey();
  let keyText: string;
  try {
    keyText = sshKey.loadText('qa_data/ssh/id_rsa');
  } catch {
    console.log(sshKey.lastErrorText);
    return;
  }

  try {
    sshKey.fromOpenSshPrivateKey(keyText);
  } catch {
    console.log(sshKey.lastErrorText);
    return;
  }

  // Authenticate with the SSH server using the private key.
  try {
    await mailman.sshAuthenticatePkAsync('sshUser', sshKey);
  } catch {
    console.log(mailman.lastErrorText);
    return;
  }

  // POP3 operations now travel through the SSH tunnel.
  const count = await mailman.getMailboxCountAsync();
  if (count < 0) {
    console.log('Failed to get the mailbox count.');
  } else {
    console.log(`Mailbox count: ${count}`);
  }

  try {
    await mailman.sshCloseTunnelAsync();
  } catch {
    console.log(mailman.lastErrorText);
    return;
  }

  // Note: The path "qa_data/ssh/id_rsa" is a relative local filesystem path,
  // relative to the current working directory of the running application.
}