The ssh::Session class contains the state of a SSH connection. More...
#include <include/libssh/libsshpp.hpp>
Public Member Functions | |
Channel * | acceptForward (int timeout_ms) |
accept an incoming forward connection | |
void | connect () |
connects to the remote host | |
void | disconnect () |
Disconnects from the SSH server and closes connection. | |
int | getAuthList () |
Returns the available authentication methods from the server. | |
const char * | getDisconnectMessage () |
Returns the disconnect message from the server, if any. | |
std::string | getIssueBanner () |
gets the Issue banner from the ssh server | |
int | getOpensshVersion () |
returns the OpenSSH version (server) if possible | |
socket_t | getSocket () |
returns the file descriptor used for the communication | |
int | getVersion () |
returns the version of the SSH protocol being used | |
int | isServerKnown () |
verifies that the server is known | |
void | optionsCopy (const Session &source) |
copies options from a session to another | |
void | optionsParseConfig (const char *file) |
parses a configuration file for options | |
void | setOption (enum ssh_options_e type, long int option) |
sets an SSH session options | |
void | setOption (enum ssh_options_e type, void *option) |
sets an SSH session options | |
void | setOption (enum ssh_options_e type, const char *option) |
sets an SSH session options | |
void | silentDisconnect () |
silently disconnect from remote host | |
int | userauthAutopubkey (void) |
Authenticates automatically using public key. | |
int | userauthNone () |
Authenticates using the "none" method. | |
int | userauthOfferPubkey (int type, ssh_string pubkey) |
Try to authenticate using the publickey method. | |
int | userauthPassword (const char *password) |
Authenticates using the password method. | |
int | userauthPubkey (ssh_string pubkey, ssh_private_key privkey) |
Authenticates using the publickey method. | |
int | writeKnownhost () |
Writes the known host file with current host key. |
The ssh::Session class contains the state of a SSH connection.
Channel * ssh::Session::acceptForward | ( | int | timeout_ms | ) |
accept an incoming forward connection
[in] | timeout_ms | timeout for waiting, in ms |
References ssh_forward_accept().
void ssh::Session::connect | ( | ) | [inline] |
connects to the remote host
SshException | on error |
References ssh_connect().
void ssh::Session::disconnect | ( | ) | [inline] |
Disconnects from the SSH server and closes connection.
References ssh_disconnect().
int ssh::Session::getAuthList | ( | ) | [inline] |
Returns the available authentication methods from the server.
SshException | on error |
References ssh_userauth_list().
const char* ssh::Session::getDisconnectMessage | ( | ) | [inline] |
Returns the disconnect message from the server, if any.
References ssh_get_disconnect_message().
std::string ssh::Session::getIssueBanner | ( | ) | [inline] |
gets the Issue banner from the ssh server
References ssh_get_issue_banner().
int ssh::Session::getOpensshVersion | ( | ) | [inline] |
returns the OpenSSH version (server) if possible
References ssh_get_openssh_version().
socket_t ssh::Session::getSocket | ( | ) | [inline] |
returns the file descriptor used for the communication
References ssh_get_fd().
int ssh::Session::getVersion | ( | ) | [inline] |
returns the version of the SSH protocol being used
References ssh_get_version().
int ssh::Session::isServerKnown | ( | ) | [inline] |
verifies that the server is known
SshException | on error |
References ssh_is_server_known().
void ssh::Session::optionsCopy | ( | const Session & | source | ) | [inline] |
copies options from a session to another
SshException | on error |
References ssh_options_copy().
void ssh::Session::optionsParseConfig | ( | const char * | file | ) | [inline] |
parses a configuration file for options
SshException | on error |
[in] | file | configuration file name |
References ssh_options_parse_config().
void ssh::Session::setOption | ( | enum ssh_options_e | type, | |
const char * | option | |||
) | [inline] |
sets an SSH session options
type | Type of option | |
option | cstring containing the value of option |
SshException | on error |
References ssh_options_set().
void ssh::Session::setOption | ( | enum ssh_options_e | type, | |
long int | option | |||
) | [inline] |
sets an SSH session options
type | Type of option | |
option | long integer containing the value of option |
SshException | on error |
References ssh_options_set().
void ssh::Session::setOption | ( | enum ssh_options_e | type, | |
void * | option | |||
) | [inline] |
sets an SSH session options
type | Type of option | |
option | void pointer containing the value of option |
SshException | on error |
References ssh_options_set().
void ssh::Session::silentDisconnect | ( | ) | [inline] |
silently disconnect from remote host
References ssh_silent_disconnect().
int ssh::Session::userauthAutopubkey | ( | void | ) | [inline] |
Authenticates automatically using public key.
SshException | on error |
References ssh_userauth_autopubkey().
int ssh::Session::userauthNone | ( | ) | [inline] |
Authenticates using the "none" method.
Prefer using autopubkey if possible.
SshException | on error |
References ssh_userauth_none().
int ssh::Session::userauthOfferPubkey | ( | int | type, | |
ssh_string | pubkey | |||
) | [inline] |
Try to authenticate using the publickey method.
[in] | type | public key type |
[in] | pubkey | public key to use for authentication |
SshException | on error |
References ssh_userauth_offer_pubkey().
int ssh::Session::userauthPassword | ( | const char * | password | ) | [inline] |
Authenticates using the password method.
[in] | password | password to use for authentication |
SshException | on error |
References ssh_userauth_password().
int ssh::Session::userauthPubkey | ( | ssh_string | pubkey, | |
ssh_private_key | privkey | |||
) | [inline] |
Authenticates using the publickey method.
[in] | pubkey | public key to use for authentication |
[in] | privkey | private key to use for authentication |
SshException | on error |
References ssh_userauth_pubkey().
int ssh::Session::writeKnownhost | ( | ) | [inline] |
Writes the known host file with current host key.
SshException | on error |
References ssh_write_knownhost().