C#

SSH Keyboard Authentication

See more SSH Examples

Demonstrates how to implement keyboard authentication with an SSH server. C#

bool success = false;

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

Chilkat.Ssh ssh = new Chilkat.Ssh();

//  Set some timeouts, in milliseconds:
ssh.ConnectTimeoutMs = 5000;
ssh.IdleTimeoutMs = 15000;

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
string hostname = "sftp.example.com";
int port = 22;
success = ssh.Connect(hostname,port);
if (success != true) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

//  Begin keyboard authentication..
string xmlResponse = ssh.StartKeyboardAuth("myLogin");
if (ssh.LastMethodSuccess != true) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

//  If a user authentication banner was received, then your app
//  may display it prior to prompting for the password.
Debug.WriteLine("UserAuthBanner: " + ssh.UserAuthBanner);

Chilkat.Xml xml = new Chilkat.Xml();

success = xml.LoadXml(xmlResponse);
//  Assume LoadXml succeeds for the example..
if (xml.HasChildWithTag("success") == true) {
    Debug.WriteLine("No password required, already authenticated.");
    return;
}

if (xml.HasChildWithTag("error") == true) {
    Debug.WriteLine("Authentication already failed.");
    return;
}

//  See the online reference documentation for Chilkat SSH.
//  The XML returned by StartKeyboardAuth will contain an infoRequest
//  with one or more prompts that your application may choose to display.

//  Call ContinueKeyboardAuth, passing in the whatever information is requires (such as the password).
//  Typically, keyboard authentication requires one call to ContinueKeyboardAuth 
//  using the password.  Theoretically, the SSH server could prompt for additional pieces
//  of information.  The authentication is completed when the XML returned contains
//  either a "success" or "error" child node.

//  This example asumes only one call to ContinueKeyboardAuth is required.
xmlResponse = ssh.ContinueKeyboardAuth("myPassword");
if (ssh.LastMethodSuccess != true) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

success = xml.LoadXml(xmlResponse);
//  Assume LoadXml succeeds for the example..
if (xml.HasChildWithTag("success") == true) {
    Debug.WriteLine("SSH Keyboard Authentication Successful!");
    return;
}

if (xml.HasChildWithTag("error") == true) {
    Debug.WriteLine("Authentication failed.");
    return;
}