PowerShell

SSH Keyboard Authentication

See more SSH Examples

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

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$ssh = New-Object 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.
$hostname = "sftp.example.com"
$port = 22
$success = $ssh.Connect($hostname,$port)
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# Begin keyboard authentication..
$xmlResponse = $ssh.StartKeyboardAuth("myLogin")
if ($ssh.LastMethodSuccess -ne $true) {
    $($ssh.LastErrorText)
    exit
}

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

$xml = New-Object Chilkat.Xml

$success = $xml.LoadXml($xmlResponse)
# Assume LoadXml succeeds for the example..
if ($xml.HasChildWithTag("success") -eq $true) {
    $("No password required, already authenticated.")
    exit
}

if ($xml.HasChildWithTag("error") -eq $true) {
    $("Authentication already failed.")
    exit
}

# 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 -ne $true) {
    $($ssh.LastErrorText)
    exit
}

$success = $xml.LoadXml($xmlResponse)
# Assume LoadXml succeeds for the example..
if ($xml.HasChildWithTag("success") -eq $true) {
    $("SSH Keyboard Authentication Successful!")
    exit
}

if ($xml.HasChildWithTag("error") -eq $true) {
    $("Authentication failed.")
    exit
}