Platforms to show: All Mac Windows Linux Cross-Platform

SSH2SessionMBS class

• event KeyboardCallback(Name as string, Instruction as string, PromptCount as Integer, Prompts() as SSH2UserAuthKeyboardInteractivePromptMBS, responses() as SSH2UserAuthKeyboardInteractiveResponseMBS)
• 8 properties
  • property Authenticated as Boolean
  • property Blocking as Boolean
  • property Handle as Integer
  • property LastErrNo as Integer
  • property LastError as Integer
  • property Socket as TCPSocket
  • property Tag as Variant
  • property TimeOut as Integer
• 24 methods
  • method Banner as string
  • method ConfigureKeepAlive(WantReply as Boolean = true, Interval as Integer = 2)
  • method Constructor(IP as string, Port as Integer = 22, TimeOut as Integer = 30)
  • method Constructor(socket as TCPSocket)
  • method Constructor(socketHandle as Integer, CloseSocketLater as boolean = false)
  • method Destructor
  • method Disconnect(description as string)
  • method Disconnect(reason as Integer, description as string, lang as string = "")
  • method HostKey(byref Type as Integer) as string
  • method HostKeyHash(HashType as Integer) as string
  • method OpenDirectTCPIPChannel(host as string, port as integer, sourceHost as string = "127.0.0.1", sourcePort as Integer = 22) as SSH2ChannelMBS
  • method OpenSession as SSH2ChannelMBS
  • method SessionFlag(Flag as Integer, Value as boolean)
  • method SessionHandshake
  • method SetBanner(Banner as string)
  • method SetMethodPreference(methodType as Integer, Pref as string) as Boolean
  • method SupportedAlgorithms(methodType as Integer) as String()
  • method UserAuthKeyboardInteractive(UserName as string)
  • method UserAuthList(username as string) as string
  • method UserAuthPassword(UserName as string, Password as string)
  • method UserAuthPublicKeyFromFile(UserName as string, publickey as folderitem, privatekey as folderitem, Passphrase as string)
  • method UserAuthPublicKeyFromFile(UserName as string, publickey as string, privatekey as string, Passphrase as string)
  • method UserAuthPublicKeyFromMemory(UserName as string, publickey as string, privatekey as string, Passphrase as string)
  • method WaitSocket(TimeOut as Double = 0.1)
• 3 shared methods
  • shared method CipherNames as String()
  • shared method DigestNames as String()
  • shared method Version as string
• 64 constants

This class has no sub classes.

Some methods using this class:

• SSH2ChannelMBS.Constructor(session as SSH2SessionMBS)
• SSH2TunnelMBS.Constructor(session as SSH2SessionMBS)

Some properties using for this class:

• SSH2ChannelMBS.Session as SSH2SessionMBS
• SSH2TunnelMBS.Session as SSH2SessionMBS

Some examples using this class:

• /Network/SSH/SSH
• /Network/SSH/SSH console
• /Network/SSH/SSH execute
• /Network/SSH/SSH Terminal
• /Network/SSH/SSH tunnel
• /Network/SSH/SSH tunnel connection
• /Network/SSH/SSH tunnel for database
• /Network/SSH/SSH tunnel for database Desktop
• /Network/SSH/SSH with Xojo Socket

Blog Entries

• MBS Xojo Plugins, version 22.5pr1
• MBS Xojo Plugins, version 22.3pr3
• News from the MBS Xojo Plugins Version 20.5
• SSH Terminal example for Xojo
• News from the MBS Xojo Plugins Version 20.4
• MBS Xojo Plugins, version 18.5pr1
• MBS Xojo Plugins 18.3
• MBS Xojo Plugins, version 18.3pr3
• SSH tunnel in Xojo
• MonkeyBread Software Releases the MBS Xojo / Real Studio plug-ins in version 15.0

Videos

• Presentation from Xojo Developer Conference 2019 in Miami.

Release notes

• Version 22.5
  • Fixed timeout for SSH2SessionMBS class on macOS/Linux.
• Version 22.3
  • Added TimeOut parameter for WaitSocket method in SSH2SessionMBS class to customize it.
  • Changed constructor for SSH2SessionMBS class to be multi threaded and yield more.
• Version 18.5
  • Added CipherNames and DigestNames to SSH2SessionMBS and CURLSMBS classes.
  • Added SetMethodPreference and SupportedAlgorithms methods to SSH2SessionMBS class.
• Version 18.3
  • Added SSH2SessionMBS.OpenDirectTCPIPChannel function to tunnel request through server.
  • Updated SSH2SessionMBS.Constructor to work with IPv4 and IPv6 as well as domain names.

The items on this page are in the following plugins: MBS Network Plugin.

SSH2ConnectFailedExceptionMBS   -   SSH2TunnelMBS