52 #define LIBSSH_LEGACY_0_4    54 #include <libssh/libssh.h>    55 #include <libssh/server.h>    68 #ifndef SSH_NO_CPP_EXCEPTIONS    82     description=e.description;
   101   std::string description;
   107 #define ssh_throw(x) if((x)==SSH_ERROR) throw SshException(getCSession())   108 #define ssh_throw_null(CSession,x) if((x)==NULL) throw SshException(CSession)   109 #define void_throwable void   110 #define return_throwable return   117 #define ssh_throw(x) if((x)==SSH_ERROR) return SSH_ERROR   118 #define ssh_throw_null(CSession,x) if((x)==NULL) return NULL   119 #define void_throwable int   120 #define return_throwable return SSH_OK   142   void_throwable 
setOption(
enum ssh_options_e type, 
const char *option){
   152   void_throwable 
setOption(
enum ssh_options_e type, 
long int option){
   162   void_throwable 
setOption(
enum ssh_options_e type, 
void *option){
   231   int userauthPrivatekeyFile(
const char *filename,
   232       const char *passphrase);
   284     std::string ret= std::string(banner);
   313   void log(
int priority, 
const char *format, ...){
   317     va_start(va, format);
   318     vsnprintf(buffer, 
sizeof(buffer), format, va);
   320     _ssh_log(priority, 
"libsshpp", 
"%s", buffer);
   365   inline Channel *acceptForward(
int timeout_ms);
   368   void_throwable cancelForward(
const char *address, 
int port){
   374   void_throwable listenForward(
const char *address, 
int port,
   382   ssh_session c_session;
   383   ssh_session getCSession(){
   400     this->session=&session;
   417     ssh_throw_null(getCSession(),x11chan);
   466   int openForward(
const char *remotehost, 
int remoteport,
   467       const char *sourcehost=NULL, 
int localport=0){
   469         sourcehost, localport);
   474   void_throwable openSession(){
   479   int poll(
bool is_stderr=
false){
   484   int read(
void *dest, 
size_t count, 
bool is_stderr){
   487     if(count > 0x7fffffff)
   493   int read(
void *dest, 
size_t count, 
int timeout){
   496     if(count > 0x7fffffff)
   502   int read(
void *dest, 
size_t count, 
bool is_stderr=
false, 
int timeout=-1){
   505     if(count > 0x7fffffff)
   511   int readNonblocking(
void *dest, 
size_t count, 
bool is_stderr=
false){
   514     if(count > 0x7fffffff)
   520   void_throwable requestEnv(
const char *name, 
const char *value){
   526   void_throwable requestExec(
const char *cmd){
   531   void_throwable requestPty(
const char *term=NULL, 
int cols=0, 
int rows=0){
   533     if(term != NULL && cols != 0 && rows != 0)
   541   void_throwable requestShell(){
   546   void_throwable requestSendSignal(
const char *signum){
   551   void_throwable requestSubsystem(
const char *subsystem){
   556   int requestX11(
bool single_connection,
   557       const char *protocol, 
const char *cookie, 
int screen_number){
   559         protocol, cookie, screen_number);
   563   void_throwable sendEof(){
   577   int write(
const void *data, 
size_t len, 
bool is_stderr=
false){
   588   ssh_session getCSession(){
   589     return session->getCSession();
   592     this->channel=c_channel;
   593     this->session=&session;
   604     ssh_channel forward =
   606     ssh_throw_null(c_session,forward);
 int userauthNone()
Authenticates using the "none" method. 
Definition: libsshpp.hpp:192
int getAuthList()
Returns the available authentication methods from the server. 
Definition: libsshpp.hpp:238
Definition: libsshpp.hpp:61
int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout_ms)
Reads data from a channel. 
Definition: channels.c:2627
void connect()
connects to the remote host 
Definition: libsshpp.hpp:170
int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file. 
Definition: options.c:1200
Channel * acceptX11(int timeout_ms)
accept an incoming X11 connection 
Definition: libsshpp.hpp:415
int ssh_channel_request_x11(ssh_channel channel, int single_connection, const char *protocol, const char *cookie, int screen_number)
Sends the "x11-req" channel request over an existing session channel. 
Definition: channels.c:1864
int ssh_channel_request_shell(ssh_channel channel)
Request a shell. 
Definition: channels.c:1754
int ssh_channel_open_forward(ssh_channel channel, const char *remotehost, int remoteport, const char *sourcehost, int localport)
Open a TCP/IP forwarding channel. 
Definition: channels.c:937
int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF. 
Definition: channels.c:1412
int isServerKnown()
verifies that the server is known 
Definition: libsshpp.hpp:308
int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel. 
Definition: channels.c:1065
void close()
closes a channel 
Definition: libsshpp.hpp:437
int ssh_channel_close(ssh_channel channel)
Close a channel. 
Definition: channels.c:1117
int userauthPublickey(ssh_key privkey)
Authenticates using the publickey method. 
Definition: libsshpp.hpp:226
int getVersion()
returns the version of the SSH protocol being used 
Definition: libsshpp.hpp:299
The ssh::Session class contains the state of a SSH connection. 
Definition: libsshpp.hpp:126
LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel stderr. 
Definition: channels.c:3176
int ssh_get_openssh_version(ssh_session session)
Get the version of the OpenSSH server, if it is not an OpenSSH server then 0 will be returned...
Definition: client.c:672
int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server. 
Definition: auth.c:318
const char * ssh_get_error(void *error)
Retrieve the error text message from the last error. 
Definition: error.c:111
int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel. 
Definition: channels.c:1369
int ssh_channel_request_pty_size(ssh_channel channel, const char *term, int cols, int rows)
Request a pty with a specific type and size. 
Definition: channels.c:1618
int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp"). 
Definition: channels.c:1780
the ssh::Channel class describes the state of an SSH channel. 
Definition: libsshpp.hpp:395
int ssh_get_version(ssh_session session)
Get the protocol version of the session. 
Definition: session.c:800
int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables. 
Definition: channels.c:2298
int userauthPublickeyAuto(void)
Authenticates automatically using public key. 
Definition: libsshpp.hpp:180
char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server. 
Definition: client.c:646
int write(const void *data, size_t len, bool is_stderr=false)
Writes on a channel. 
Definition: libsshpp.hpp:577
void changePtySize(int cols, int rows)
change the size of a pseudoterminal 
Definition: libsshpp.hpp:427
std::string getIssueBanner()
gets the Issue banner from the ssh server 
Definition: libsshpp.hpp:282
int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure. 
Definition: options.c:64
void disconnect()
Disconnects from the SSH server and closes connection. 
Definition: libsshpp.hpp:246
int getCode()
returns the Error code 
Definition: libsshpp.hpp:89
int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding). 
Definition: channels.c:860
Some people do not like C++ exceptions. 
Definition: libsshpp.hpp:74
int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not. 
Definition: channels.c:1382
int ssh_write_knownhost(ssh_session session)
Write the current server as known in the known hosts file. 
Definition: known_hosts.c:526
int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not. 
Definition: channels.c:1398
socket_t getSocket()
returns the file descriptor used for the communication 
Definition: libsshpp.hpp:275
void optionsParseConfig(const char *file)
parses a configuration file for options 
Definition: libsshpp.hpp:336
void setOption(enum ssh_options_e type, void *option)
sets an SSH session options 
Definition: libsshpp.hpp:162
int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read. 
Definition: channels.c:2789
int writeKnownhost()
Writes the known host file with current host key. 
Definition: libsshpp.hpp:351
ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel. 
Definition: channels.c:79
int ssh_options_set(ssh_session session, enum ssh_options_e type, const void *value)
This function can set all possible ssh options. 
Definition: options.c:382
int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password. 
Definition: auth.c:1122
int ssh_userauth_publickey_auto(ssh_session session, const char *username, const char *passphrase)
Tries to automatically authenticate with public key and "none". 
Definition: auth.c:906
int ssh_userauth_publickey(ssh_session session, const char *username, const ssh_key privkey)
Authenticate with public/private key. 
Definition: auth.c:550
socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection. 
Definition: session.c:533
int userauthPassword(const char *password)
Authenticates using the password method. 
Definition: libsshpp.hpp:203
bool isEof()
returns true if channel is in EOF state 
Definition: libsshpp.hpp:457
int ssh_channel_change_pty_size(ssh_channel channel, int cols, int rows)
Change the size of the terminal associated to a channel. 
Definition: channels.c:1707
int ssh_connect(ssh_session session)
Connect to the ssh server. 
Definition: client.c:528
void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server). 
Definition: client.c:686
int getOpensshVersion()
returns the OpenSSH version (server) if possible 
Definition: libsshpp.hpp:292
bool isClosed()
returns true if channel is in closed state 
Definition: libsshpp.hpp:451
int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method. 
Definition: auth.c:354
ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel. 
Definition: channels.c:1980
int ssh_channel_listen_forward(ssh_session session, const char *address, int port, int *bound_port)
Sends the "tcpip-forward" global request to ask the server to begin listening for inbound connections...
Definition: channels.c:2165
int ssh_channel_request_send_signal(ssh_channel channel, const char *signum)
Send a signal to remote process (as described in RFC 4254, section 6.9). 
Definition: channels.c:2443
std::string getError()
returns the error message of the last exception 
Definition: libsshpp.hpp:96
ssh_channel ssh_channel_accept_forward(ssh_session session, int timeout_ms, int *destination_port)
Accept an incoming TCP/IP forwarding channel and get information about incomming connection. 
Definition: channels.c:2228
int userauthTryPublickey(ssh_key pubkey)
Try to authenticate using the publickey method. 
Definition: libsshpp.hpp:215
void silentDisconnect()
silently disconnect from remote host 
Definition: libsshpp.hpp:343
Channel * acceptForward(int timeout_ms)
accept an incoming forward connection 
Definition: libsshpp.hpp:603
int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell. 
Definition: channels.c:2368
bool isOpen()
returns true if channel is in open state 
Definition: libsshpp.hpp:463
int ssh_channel_request_pty(ssh_channel channel)
Request a PTY. 
Definition: channels.c:1688
void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket. 
Definition: session.c:434
void setOption(enum ssh_options_e type, long int option)
sets an SSH session options 
Definition: libsshpp.hpp:152
const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server. 
Definition: session.c:775
ssh_session ssh_new(void)
Create a new ssh session. 
Definition: session.c:61
void ssh_channel_free(ssh_channel channel)
Close and free a channel. 
Definition: channels.c:993
int ssh_userauth_try_publickey(ssh_session session, const char *username, const ssh_key pubkey)
Try to authenticate with the given public key. 
Definition: auth.c:441
int ssh_is_server_known(ssh_session session)
Check if the server is known. 
Definition: known_hosts.c:406
void setOption(enum ssh_options_e type, const char *option)
sets an SSH session options 
Definition: libsshpp.hpp:142
int ssh_channel_get_exit_status(ssh_channel channel)
Get the exit status of the channel (error code from the executed instruction). 
Definition: channels.c:2918
int ssh_channel_cancel_forward(ssh_session session, const char *address, int port)
Sends the "cancel-tcpip-forward" global request to ask the server to cancel the tcpip-forward request...
Definition: channels.c:2247
const char * getDisconnectMessage()
Returns the disconnect message from the server, if any. 
Definition: libsshpp.hpp:253
void optionsCopy(const Session &source)
copies options from a session to another 
Definition: libsshpp.hpp:327
void ssh_free(ssh_session session)
Deallocate a SSH session handle. 
Definition: session.c:184
int ssh_channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count, int is_stderr)
Do a nonblocking read on the channel. 
Definition: channels.c:2737
int ssh_get_error_code(void *error)
Retrieve the error code from the last error. 
Definition: error.c:131