ComponentPro UltimateSftp

      Authenticate(String, KeyboardInteractiveAuthenticationEventHandler) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Authenticates the user to the SFTP server.


      public void Authenticate(
         string userName, 
         KeyboardInteractiveAuthenticationEventHandler keyboardInteractiveAuthenticationHandler


      The name of the user to be authenticated.
      The keyboard interactive authentication handler.


      Shows how to use Connect, Authenticate, and Disconnect methods to establish a connection and disconnect.

      using System;
      using System.IO;
      using ComponentPro.Net;
      static void Main()
          // Create a new class instance. 
          using (Sftp client = new Sftp())
              // Connect to the SFTP server. 
              // Authenticate. 
              client.Authenticate("userName", handler);
              // Do something here... 
              client.DownloadFile("/my remote file.dat", "my local file");
      static void handler(object sender, KeyboardInteractiveAuthenticationEventArgs e)
          Console.WriteLine("Instructions: " + e.Instructions);
          foreach (KeyboardInteractiveRequest r in e.Requests)
              Console.WriteLine("Prompt: " + r.Prompt);
              Console.Write("Enter response: ");
              r.Response = Console.ReadLine();
          Console.Write("Continue or cancel (y/n)?: ");
          if (Console.Read() == 'n')
              e.Cancel = true;


      .NET Compact Framework.NET Compact Framework

      Supported version: 2.0, 3.5, and 3.9
      Assembly: ComponentPro.Sftp.CF (in ComponentPro.Sftp.CF.dll)

      .NET Framework.NET Framework

      Supported version: 2.0, 3.0, 3.5, 4.0, 4.5.x, 4.6.x and later
      Assembly: ComponentPro.Sftp (in ComponentPro.Sftp.dll)

      Portable Class Library for Windows Phone 8.1 and Windows 8.1 Store AppsPortable Class Library for Windows Phone 8.1 and Windows 8.1 Store Apps

      Supported version: 4.6.x and later
      Assembly: ComponentPro.Sftp.WinPcl (in ComponentPro.Sftp.WinPcl.dll)

      Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)

      Supported version: 4.6.x and later
      Assembly: ComponentPro.Sftp.Uwp (in ComponentPro.Sftp.Uwp.dll)

      Xamarin AndroidXamarin Android

      Supported version: 2.3 and later
      Assembly: ComponentPro.Sftp.Android (in ComponentPro.Sftp.Android.dll)

      Xamarin MacXamarin Mac

      Supported version: 2.0.x and later
      Assembly: ComponentPro.Sftp.Mac (in ComponentPro.Sftp.Mac.dll)

      Xamarin iOSXamarin iOS

      Supported version: 5.1.x and later
      Assembly: ComponentPro.Sftp.iOS (in ComponentPro.Sftp.iOS.dll)

      See Also