Tamir.SharpSsh.SshBase Class Reference
A wrapper class for JSch's SSH channel. More...
Classes | |
| class | KeyboardInteractiveUserInfo |
| For password and KI auth modes. More... | |
Public Member Functions | |
| SshBase (string sftpHost, string user, string password) | |
| Constructs a new SSH instance. | |
| SshBase (string sftpHost, string user) | |
| Constructs a new SSH instance. | |
| virtual void | AddIdentityFile (string privateKeyFile) |
| Adds identity file for publickey user authentication. | |
| virtual void | AddIdentityFile (string privateKeyFile, string passphrase) |
| Adds identity file for publickey user authentication. | |
| virtual void | Connect () |
| Connect to remote SSH server. | |
| virtual void | Connect (int tcpPort) |
| Connect to remote SSH server. | |
| virtual void | Close () |
| Closes the SSH subsystem. | |
Protected Member Functions | |
| virtual void | ConnectSession (int tcpPort) |
| virtual void | ConnectChannel () |
| virtual void | OnConnected () |
| virtual void | OnChannelReceived () |
Protected Attributes | |
| string | m_host |
| string | m_user |
| string | m_pass |
| JSch | m_jsch |
| Session | m_session |
| Channel | m_channel |
Properties | |
| abstract string | ChannelType [get] |
| virtual bool | Connected [get] |
| Return true if the SSH subsystem is connected. | |
| string | Cipher [get] |
| Gets the Cipher algorithm name used in this SSH connection. | |
| string | Mac [get] |
| Gets the MAC algorithm name used in this SSH connection. | |
| string | ServerVersion [get] |
| Gets the server SSH version string. | |
| string | ClientVersion [get] |
| Gets the client SSH version string. | |
| string | Host [get] |
| HostKey | HostKey [get] |
| int | Port [get] |
| string | Password [get, set] |
| The password string of the SSH subsystem. | |
| string | Username [get] |
| static Version | Version [get] |
Detailed Description
A wrapper class for JSch's SSH channel.
Definition at line 40 of file SshBase.cs.
Constructor & Destructor Documentation
| Tamir.SharpSsh.SshBase.SshBase | ( | string | sftpHost, | |
| string | user, | |||
| string | password | |||
| ) |
Constructs a new SSH instance.
- Parameters:
-
sftpHost The remote SSH host user The login username password The login password
Definition at line 60 of file SshBase.cs.
| Tamir.SharpSsh.SshBase.SshBase | ( | string | sftpHost, | |
| string | user | |||
| ) |
Constructs a new SSH instance.
- Parameters:
-
sftpHost The remote SSH host user The login username
Definition at line 73 of file SshBase.cs.
Member Function Documentation
| virtual void Tamir.SharpSsh.SshBase.AddIdentityFile | ( | string | privateKeyFile, | |
| string | passphrase | |||
| ) | [virtual] |
Adds identity file for publickey user authentication.
- Parameters:
-
privateKeyFile The path to the private key file passphrase A passphrase for decrypting the private key file
Definition at line 92 of file SshBase.cs.
| virtual void Tamir.SharpSsh.SshBase.AddIdentityFile | ( | string | privateKeyFile | ) | [virtual] |
Adds identity file for publickey user authentication.
- Parameters:
-
privateKeyFile The path to the private key file
Definition at line 82 of file SshBase.cs.
| virtual void Tamir.SharpSsh.SshBase.Close | ( | ) | [virtual] |
| virtual void Tamir.SharpSsh.SshBase.Connect | ( | int | tcpPort | ) | [virtual] |
Connect to remote SSH server.
- Parameters:
-
tcpPort The destination TCP port for this connection
Definition at line 111 of file SshBase.cs.
| virtual void Tamir.SharpSsh.SshBase.Connect | ( | ) | [virtual] |
| virtual void Tamir.SharpSsh.SshBase.ConnectChannel | ( | ) | [protected, virtual] |
Reimplemented in Tamir.SharpSsh.Scp, and Tamir.SharpSsh.SshExec.
Definition at line 128 of file SshBase.cs.
| virtual void Tamir.SharpSsh.SshBase.ConnectSession | ( | int | tcpPort | ) | [protected, virtual] |
Definition at line 117 of file SshBase.cs.
| virtual void Tamir.SharpSsh.SshBase.OnChannelReceived | ( | ) | [protected, virtual] |
| virtual void Tamir.SharpSsh.SshBase.OnConnected | ( | ) | [protected, virtual] |
Definition at line 136 of file SshBase.cs.
Member Data Documentation
Channel Tamir.SharpSsh.SshBase.m_channel [protected] |
Definition at line 47 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.m_host [protected] |
Definition at line 42 of file SshBase.cs.
JSch Tamir.SharpSsh.SshBase.m_jsch [protected] |
Definition at line 45 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.m_pass [protected] |
Definition at line 44 of file SshBase.cs.
Session Tamir.SharpSsh.SshBase.m_session [protected] |
Definition at line 46 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.m_user [protected] |
Definition at line 43 of file SshBase.cs.
Property Documentation
abstract string Tamir.SharpSsh.SshBase.ChannelType [get, protected] |
Reimplemented in Tamir.SharpSsh.Scp, Tamir.SharpSsh.Sftp, Tamir.SharpSsh.SshExec, and Tamir.SharpSsh.SshShell.
Definition at line 97 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.Cipher [get] |
Gets the Cipher algorithm name used in this SSH connection.
Definition at line 178 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.ClientVersion [get] |
virtual bool Tamir.SharpSsh.SshBase.Connected [get] |
string Tamir.SharpSsh.SshBase.Host [get] |
Definition at line 223 of file SshBase.cs.
HostKey Tamir.SharpSsh.SshBase.HostKey [get] |
Definition at line 232 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.Mac [get] |
string Tamir.SharpSsh.SshBase.Password [get, set] |
int Tamir.SharpSsh.SshBase.Port [get] |
Definition at line 241 of file SshBase.cs.
string Tamir.SharpSsh.SshBase.ServerVersion [get] |
string Tamir.SharpSsh.SshBase.Username [get] |
Definition at line 258 of file SshBase.cs.
Version Tamir.SharpSsh.SshBase.Version [static, get] |
Definition at line 263 of file SshBase.cs.
The documentation for this class was generated from the following file:
- C:/work/OMMR/OCHHP_OMMR_OMMR/Code/Assemblies/SharpSSH/Source/SharpSSH-1.1.1.13.src/SharpSSH/SshBase.cs
