Sample code for 30+ languages & platforms
Android™

SSH Public Key Authentication

See more SSH Examples

Demonstrates authenticating with an SSH server using public-key authentication. A private key is loaded into an SshKey object and passed to AuthenticatePk. The matching public key must already be installed on the server for the account.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: Public-key authentication is the standard for unattended and automated SSH: the private key never leaves the client, the server merely trusts the corresponding public key, and no reusable password crosses the wire. SshKey imports several formats — OpenSSH PEM keys via FromOpenSshPrivateKey and PuTTY .ppk files via FromPuttyPrivateKey — encrypted or not. For an encrypted key, set the Password property before importing. Note that LoadText is only a convenience for reading a text file into a string; it does not itself load the key.

Chilkat Android™ Downloads

Android™
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean success = false;

    //  This example requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    //  Demonstrates authenticating with an SSH server using public-key authentication.  The matching
    //  public key must already be installed on the SSH server for the account.

    CkSsh ssh = new CkSsh();

    //  Timeouts, in milliseconds.
    ssh.put_ConnectTimeoutMs(5000);
    ssh.put_ReadTimeoutMs(15000);

    String hostname = "ssh.example.com";
    int port = 22;
    success = ssh.Connect(hostname,port);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    //  LoadText is a convenience method that reads any text file into a string.  It does not itself
    //  load the key.
    CkSshKey key = new CkSshKey();
    String privKeyText = key.loadText("qa_data/my_private_key.pem");
    if (key.get_LastMethodSuccess() == false) {
        Log.i(TAG, key.lastErrorText());
        return;
        }

    //  Import the private key.  Both OpenSSH and PuTTY formats are supported, encrypted or not.
    //  This example loads an unencrypted OpenSSH-format key; for a PuTTY .ppk file, call
    //  FromPuttyPrivateKey instead.  For an encrypted key, set key.Password before importing.
    success = key.FromOpenSshPrivateKey(privKeyText);
    if (success == false) {
        Log.i(TAG, key.lastErrorText());
        return;
        }

    success = ssh.AuthenticatePk("mySshLogin",key);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    Log.i(TAG, "Public-key authentication successful.");

    ssh.Disconnect();

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}