52 #define LIBSSH_LEGACY_0_4 54 #include <libssh/libssh.h> 55 #include <libssh/server.h> 67 #ifndef SSH_NO_CPP_EXCEPTIONS 81 description=e.description;
100 std::string description;
106 #define ssh_throw(x) if((x)==SSH_ERROR) throw SshException(getCSession()) 107 #define ssh_throw_null(CSession,x) if((x)==NULL) throw SshException(CSession) 108 #define void_throwable void 109 #define return_throwable return 116 #define ssh_throw(x) if((x)==SSH_ERROR) return SSH_ERROR 117 #define ssh_throw_null(CSession,x) if((x)==NULL) return NULL 118 #define void_throwable int 119 #define return_throwable return SSH_OK 141 void_throwable
setOption(
enum ssh_options_e type,
const char *option){
151 void_throwable
setOption(
enum ssh_options_e type,
long int option){
161 void_throwable
setOption(
enum ssh_options_e type,
void *option){
230 int userauthPrivatekeyFile(
const char *filename,
231 const char *passphrase);
283 std::string ret= std::string(banner);
312 void log(
int priority,
const char *format, ...){
316 va_start(va, format);
317 vsnprintf(buffer,
sizeof(buffer), format, va);
319 _ssh_log(priority,
"libsshpp",
"%s", buffer);
364 Channel *acceptForward(
int timeout_ms);
367 void_throwable cancelForward(
const char *address,
int port){
373 void_throwable listenForward(
const char *address,
int port,
381 ssh_session c_session;
382 ssh_session getCSession(){
399 this->session=&session;
416 ssh_throw_null(getCSession(),x11chan);
465 int openForward(
const char *remotehost,
int remoteport,
466 const char *sourcehost=NULL,
int localport=0){
468 sourcehost, localport);
473 void_throwable openSession(){
478 int poll(
bool is_stderr=
false){
483 int read(
void *dest,
size_t count,
bool is_stderr=
false){
486 if(count > 0x7fffffff)
492 int readNonblocking(
void *dest,
size_t count,
bool is_stderr=
false){
495 if(count > 0x7fffffff)
501 void_throwable requestEnv(
const char *name,
const char *value){
507 void_throwable requestExec(
const char *cmd){
512 void_throwable requestPty(
const char *term=NULL,
int cols=0,
int rows=0){
514 if(term != NULL && cols != 0 && rows != 0)
522 void_throwable requestShell(){
527 void_throwable requestSendSignal(
const char *signum){
532 void_throwable requestSubsystem(
const char *subsystem){
537 int requestX11(
bool single_connection,
538 const char *protocol,
const char *cookie,
int screen_number){
540 protocol, cookie, screen_number);
544 void_throwable sendEof(){
558 int write(
const void *data,
size_t len,
bool is_stderr=
false){
569 ssh_session getCSession(){
570 return session->getCSession();
573 this->channel=c_channel;
574 this->session=&session;
588 ssh_throw_null(c_session,forward);
int userauthNone()
Authenticates using the "none" method.
Definition: libsshpp.hpp:191
int getAuthList()
Returns the available authentication methods from the server.
Definition: libsshpp.hpp:237
Definition: libsshpp.hpp:60
void connect()
connects to the remote host
Definition: libsshpp.hpp:169
int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition: options.c:1174
Channel * acceptX11(int timeout_ms)
accept an incoming X11 connection
Definition: libsshpp.hpp:414
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:1947
int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition: channels.c:1830
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:1022
int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition: channels.c:1482
ssh_channel ssh_forward_accept(ssh_session session, int timeout_ms)
Accept an incoming TCP/IP forwarding channel.
Definition: channels.c:2322
int isServerKnown()
verifies that the server is known
Definition: libsshpp.hpp:307
int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition: channels.c:1163
void close()
closes a channel
Definition: libsshpp.hpp:436
int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition: channels.c:1213
int userauthPublickey(ssh_key privkey)
Authenticates using the publickey method.
Definition: libsshpp.hpp:225
int ssh_forward_cancel(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:2357
int getVersion()
returns the version of the SSH protocol being used
Definition: libsshpp.hpp:298
The ssh::Session class contains the state of a SSH connection.
Definition: libsshpp.hpp:125
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:3280
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:610
int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server.
Definition: auth.c:339
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:1439
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:1693
int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp").
Definition: channels.c:1856
the ssh::Channel class describes the state of an SSH channel.
Definition: libsshpp.hpp:394
int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition: session.c:717
int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition: channels.c:2406
int userauthPublickeyAuto(void)
Authenticates automatically using public key.
Definition: libsshpp.hpp:179
char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition: client.c:584
int write(const void *data, size_t len, bool is_stderr=false)
Writes on a channel.
Definition: libsshpp.hpp:558
void changePtySize(int cols, int rows)
change the size of a pseudoterminal
Definition: libsshpp.hpp:426
std::string getIssueBanner()
gets the Issue banner from the ssh server
Definition: libsshpp.hpp:281
int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure.
Definition: options.c:65
void disconnect()
Disconnects from the SSH server and closes connection.
Definition: libsshpp.hpp:245
int getCode()
returns the Error code
Definition: libsshpp.hpp:88
int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition: channels.c:945
Some people do not like C++ exceptions.
Definition: libsshpp.hpp:73
int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition: channels.c:1452
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:1468
socket_t getSocket()
returns the file descriptor used for the communication
Definition: libsshpp.hpp:274
void optionsParseConfig(const char *file)
parses a configuration file for options
Definition: libsshpp.hpp:335
void setOption(enum ssh_options_e type, void *option)
sets an SSH session options
Definition: libsshpp.hpp:161
int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition: channels.c:2923
int writeKnownhost()
Writes the known host file with current host key.
Definition: libsshpp.hpp:350
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:389
int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition: auth.c:1320
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:1103
int ssh_userauth_publickey(ssh_session session, const char *username, const ssh_key privkey)
Authenticate with public/private key.
Definition: auth.c:660
socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition: session.c:450
int userauthPassword(const char *password)
Authenticates using the password method.
Definition: libsshpp.hpp:202
bool isEof()
returns true if channel is in EOF state
Definition: libsshpp.hpp:456
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:1786
int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition: client.c:471
void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server).
Definition: client.c:624
int getOpensshVersion()
returns the OpenSSH version (server) if possible
Definition: libsshpp.hpp:291
bool isClosed()
returns true if channel is in closed state
Definition: libsshpp.hpp:450
int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method.
Definition: auth.c:375
ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition: channels.c:2068
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:2573
std::string getError()
returns the error message of the last exception
Definition: libsshpp.hpp:95
int userauthTryPublickey(ssh_key pubkey)
Try to authenticate using the publickey method.
Definition: libsshpp.hpp:214
void silentDisconnect()
silently disconnect from remote host
Definition: libsshpp.hpp:342
Channel * acceptForward(int timeout_ms)
accept an incoming forward connection
Definition: libsshpp.hpp:585
int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition: channels.c:2492
bool isOpen()
returns true if channel is in open state
Definition: libsshpp.hpp:462
int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition: channels.c:1767
void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition: session.c:351
int ssh_forward_listen(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:2270
void setOption(enum ssh_options_e type, long int option)
sets an SSH session options
Definition: libsshpp.hpp:151
const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition: session.c:692
ssh_session ssh_new(void)
Create a new ssh session.
Definition: session.c:58
void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition: channels.c:1091
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:498
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:141
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:3047
const char * getDisconnectMessage()
Returns the disconnect message from the server, if any.
Definition: libsshpp.hpp:252
int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr)
Reads data from a channel.
Definition: channels.c:2736
void optionsCopy(const Session &source)
copies options from a session to another
Definition: libsshpp.hpp:326
void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition: session.c:172
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:2871
int ssh_get_error_code(void *error)
Retrieve the error code from the last error.
Definition: error.c:131