Ruby

Continue SFTP Keyboard-Interactive Authentication

Demonstrates the Chilkat SFtp.ContinueKeyboardAuth method, which submits a response to a keyboard-interactive prompt. The only argument is the response text; for a request with multiple prompts, an XML response is supplied instead. It returns XML indicating the next prompt or the final result.

Background: This is the second half of the exchange started by StartKeyboardAuth. A server may issue several rounds of prompts, so a robust client loops: submit answers, read the returned XML, and continue until it sees success or failure. On success, remember that InitializeSftp still must be called before any file operation.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the SFtp.ContinueKeyboardAuth method, which submits a response to a
#  keyboard-interactive prompt.  The only argument is the response.  For multiple prompts, an
#  XML response is supplied instead.

sftp = Chilkat::CkSFtp.new()

#  Step 1: Connect the SSH transport.  Port 22 is the usual port.
port = 22
success = sftp.Connect("sftp.example.com",port)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

#  Begin keyboard-interactive authentication to receive the server's prompt(s).
infoRequestXml = sftp.startKeyboardAuth("mySshLogin")
if (sftp.get_LastMethodSuccess() == false)
    print sftp.lastErrorText() + "\n";
    exit
end

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
password = "mySshPassword"

#  Submit the response (typically the password).  The returned XML indicates the next prompt or
#  the final result.
result = sftp.continueKeyboardAuth(password)
if (sftp.get_LastMethodSuccess() == false)
    print sftp.lastErrorText() + "\n";
    exit
end

print result + "\n";

#  On success, initialize the SFTP subsystem.
success = sftp.InitializeSftp()
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

sftp.Disconnect()