Ruby

SSH Keyboard Authentication

See more SSH Examples

Demonstrates how to implement keyboard authentication with an SSH server. Ruby

require 'chilkat'

success = false

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

ssh = Chilkat::CkSsh.new()

# Set some timeouts, in milliseconds:
ssh.put_ConnectTimeoutMs(5000)
ssh.put_IdleTimeoutMs(15000)

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
hostname = "sftp.example.com"
port = 22
success = ssh.Connect(hostname,port)
if (success != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# Begin keyboard authentication..
xmlResponse = ssh.startKeyboardAuth("myLogin")
if (ssh.get_LastMethodSuccess() != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# If a user authentication banner was received, then your app
# may display it prior to prompting for the password.
print "UserAuthBanner: " + ssh.userAuthBanner() + "\n";

xml = Chilkat::CkXml.new()

success = xml.LoadXml(xmlResponse)
# Assume LoadXml succeeds for the example..
if (xml.HasChildWithTag("success") == true)
    print "No password required, already authenticated." + "\n";
    exit
end

if (xml.HasChildWithTag("error") == true)
    print "Authentication already failed." + "\n";
    exit
end

# 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.get_LastMethodSuccess() != true)
    print ssh.lastErrorText() + "\n";
    exit
end

success = xml.LoadXml(xmlResponse)
# Assume LoadXml succeeds for the example..
if (xml.HasChildWithTag("success") == true)
    print "SSH Keyboard Authentication Successful!" + "\n";
    exit
end

if (xml.HasChildWithTag("error") == true)
    print "Authentication failed." + "\n";
    exit
end