24 #if defined _WIN32 || defined __CYGWIN__
30 #define LIBSSH_API __attribute__((dllexport))
32 #define LIBSSH_API __declspec(dllexport)
36 #define LIBSSH_API __attribute__((dllimport))
38 #define LIBSSH_API __declspec(dllimport)
43 #if __GNUC__ >= 4 && !defined(__OS2__)
44 #define LIBSSH_API __attribute__((visibility("default")))
53 typedef unsigned int uint32_t;
54 typedef unsigned short uint16_t;
55 typedef unsigned char uint8_t;
56 typedef unsigned long long uint64_t;
66 #include <sys/select.h>
70 #define SSH_STRINGIFY(s) SSH_TOSTRING(s)
71 #define SSH_TOSTRING(s) #s
74 #define SSH_VERSION_INT(a, b, c) ((a) << 16 | (b) << 8 | (c))
75 #define SSH_VERSION_DOT(a, b, c) a ##.## b ##.## c
76 #define SSH_VERSION(a, b, c) SSH_VERSION_DOT(a, b, c)
79 #define LIBSSH_VERSION_MAJOR 0
80 #define LIBSSH_VERSION_MINOR 7
81 #define LIBSSH_VERSION_MICRO 0
83 #define LIBSSH_VERSION_INT SSH_VERSION_INT(LIBSSH_VERSION_MAJOR, \
84 LIBSSH_VERSION_MINOR, \
86 #define LIBSSH_VERSION SSH_VERSION(LIBSSH_VERSION_MAJOR, \
87 LIBSSH_VERSION_MINOR, \
92 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
94 #define PRINTF_ATTRIBUTE(a,b)
98 #define SSH_DEPRECATED __attribute__ ((deprecated))
100 #define SSH_DEPRECATED
107 struct ssh_counter_struct {
111 uint64_t out_packets;
113 typedef struct ssh_counter_struct *ssh_counter;
115 typedef struct ssh_agent_struct* ssh_agent;
116 typedef struct ssh_buffer_struct* ssh_buffer;
117 typedef struct ssh_channel_struct* ssh_channel;
118 typedef struct ssh_message_struct* ssh_message;
119 typedef struct ssh_pcap_file_struct* ssh_pcap_file;
120 typedef struct ssh_key_struct* ssh_key;
121 typedef struct ssh_scp_struct* ssh_scp;
122 typedef struct ssh_session_struct* ssh_session;
123 typedef struct ssh_string_struct* ssh_string;
124 typedef struct ssh_event_struct* ssh_event;
125 typedef void* ssh_gssapi_creds;
130 typedef SOCKET socket_t;
134 typedef int socket_t;
138 #define SSH_INVALID_SOCKET ((socket_t) -1)
141 enum ssh_kex_types_e {
169 #define SSH_AUTH_METHOD_UNKNOWN 0
170 #define SSH_AUTH_METHOD_NONE 0x0001
171 #define SSH_AUTH_METHOD_PASSWORD 0x0002
172 #define SSH_AUTH_METHOD_PUBLICKEY 0x0004
173 #define SSH_AUTH_METHOD_HOSTBASED 0x0008
174 #define SSH_AUTH_METHOD_INTERACTIVE 0x0010
175 #define SSH_AUTH_METHOD_GSSAPI_MIC 0x0020
178 enum ssh_requests_e {
180 SSH_REQUEST_CHANNEL_OPEN,
186 enum ssh_channel_type_e {
187 SSH_CHANNEL_UNKNOWN=0,
189 SSH_CHANNEL_DIRECT_TCPIP,
190 SSH_CHANNEL_FORWARDED_TCPIP,
194 enum ssh_channel_requests_e {
195 SSH_CHANNEL_REQUEST_UNKNOWN=0,
196 SSH_CHANNEL_REQUEST_PTY,
197 SSH_CHANNEL_REQUEST_EXEC,
198 SSH_CHANNEL_REQUEST_SHELL,
199 SSH_CHANNEL_REQUEST_ENV,
200 SSH_CHANNEL_REQUEST_SUBSYSTEM,
201 SSH_CHANNEL_REQUEST_WINDOW_CHANGE,
202 SSH_CHANNEL_REQUEST_X11
205 enum ssh_global_requests_e {
206 SSH_GLOBAL_REQUEST_UNKNOWN=0,
207 SSH_GLOBAL_REQUEST_TCPIP_FORWARD,
208 SSH_GLOBAL_REQUEST_CANCEL_TCPIP_FORWARD,
211 enum ssh_publickey_state_e {
212 SSH_PUBLICKEY_STATE_ERROR=-1,
213 SSH_PUBLICKEY_STATE_NONE=0,
214 SSH_PUBLICKEY_STATE_VALID=1,
215 SSH_PUBLICKEY_STATE_WRONG=2
220 #define SSH_CLOSED 0x01
222 #define SSH_READ_PENDING 0x02
224 #define SSH_CLOSED_ERROR 0x04
226 #define SSH_WRITE_PENDING 0x08
228 enum ssh_server_known_e {
230 SSH_SERVER_NOT_KNOWN=0,
232 SSH_SERVER_KNOWN_CHANGED,
233 SSH_SERVER_FOUND_OTHER,
234 SSH_SERVER_FILE_NOT_FOUND
237 #ifndef MD5_DIGEST_LEN
238 #define MD5_DIGEST_LEN 16
242 enum ssh_error_types_e {
251 SSH_KEYTYPE_UNKNOWN=0,
260 SSH_KEY_CMP_PUBLIC = 0,
294 #define SSH_LOG_RARE SSH_LOG_WARNING
304 #define SSH_LOG_NONE 0
306 #define SSH_LOG_WARN 1
308 #define SSH_LOG_INFO 2
310 #define SSH_LOG_DEBUG 3
312 #define SSH_LOG_TRACE 4
319 SSH_OPTIONS_PORT_STR,
323 SSH_OPTIONS_IDENTITY,
324 SSH_OPTIONS_ADD_IDENTITY,
325 SSH_OPTIONS_KNOWNHOSTS,
327 SSH_OPTIONS_TIMEOUT_USEC,
330 SSH_OPTIONS_LOG_VERBOSITY,
331 SSH_OPTIONS_LOG_VERBOSITY_STR,
332 SSH_OPTIONS_CIPHERS_C_S,
333 SSH_OPTIONS_CIPHERS_S_C,
334 SSH_OPTIONS_COMPRESSION_C_S,
335 SSH_OPTIONS_COMPRESSION_S_C,
336 SSH_OPTIONS_PROXYCOMMAND,
337 SSH_OPTIONS_BINDADDR,
338 SSH_OPTIONS_STRICTHOSTKEYCHECK,
339 SSH_OPTIONS_COMPRESSION,
340 SSH_OPTIONS_COMPRESSION_LEVEL,
341 SSH_OPTIONS_KEY_EXCHANGE,
342 SSH_OPTIONS_HOSTKEYS,
343 SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
344 SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
345 SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
346 SSH_OPTIONS_HMAC_C_S,
347 SSH_OPTIONS_HMAC_S_C,
355 SSH_SCP_RECURSIVE=0x10
358 enum ssh_scp_request_types {
360 SSH_SCP_REQUEST_NEWDIR=1,
362 SSH_SCP_REQUEST_NEWFILE,
366 SSH_SCP_REQUEST_ENDDIR,
368 SSH_SCP_REQUEST_WARNING
384 int remoteport,
const char *sourcehost,
int localport);
389 LIBSSH_API
int ssh_channel_read(ssh_channel channel,
void *dest, uint32_t count,
int is_stderr);
390 LIBSSH_API
int ssh_channel_read_timeout(ssh_channel channel,
void *dest, uint32_t count,
int is_stderr,
int timeout_ms);
400 LIBSSH_API
int ssh_channel_request_sftp(ssh_channel channel);
403 const char *cookie,
int screen_number);
405 LIBSSH_API
int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans,
struct
409 ssh_counter counter);
410 LIBSSH_API
int ssh_channel_write(ssh_channel channel,
const void *data, uint32_t len);
411 LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel);
416 LIBSSH_API
const char *ssh_copyright(
void);
424 int *destination_port);
433 LIBSSH_API
void ssh_free(ssh_session session);
437 LIBSSH_API socket_t
ssh_get_fd(ssh_session session);
438 LIBSSH_API
char *
ssh_get_hexa(
const unsigned char *what,
size_t len);
444 enum ssh_publickey_hash_type {
445 SSH_PUBLICKEY_HASH_SHA1,
446 SSH_PUBLICKEY_HASH_MD5
449 enum ssh_publickey_hash_type type,
450 unsigned char **hash,
454 SSH_DEPRECATED LIBSSH_API
int ssh_get_pubkey_hash(ssh_session session,
unsigned char **hash);
455 SSH_DEPRECATED LIBSSH_API ssh_channel ssh_forward_accept(ssh_session session,
int timeout_ms);
456 SSH_DEPRECATED LIBSSH_API
int ssh_forward_cancel(ssh_session session,
const char *address,
int port);
457 SSH_DEPRECATED LIBSSH_API
int ssh_forward_listen(ssh_session session,
const char *address,
int port,
int *bound_port);
460 LIBSSH_API
int ssh_get_random(
void *where,
int len,
int strong);
474 LIBSSH_API
void _ssh_log(
int verbosity,
475 const char *
function,
476 const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
479 SSH_DEPRECATED LIBSSH_API
void ssh_log(ssh_session session,
481 const
char *format, ...) PRINTF_ATTRIBUTE(3, 4);
483 LIBSSH_API ssh_channel ssh_message_channel_request_open_reply_accept(ssh_message msg);
484 LIBSSH_API
int ssh_message_channel_request_reply_success(ssh_message msg);
489 LIBSSH_API
int ssh_mkdir (const
char *pathname, mode_t mode);
490 LIBSSH_API ssh_session
ssh_new(
void);
495 LIBSSH_API
int ssh_options_set(ssh_session session, enum ssh_options_e type,
497 LIBSSH_API
int ssh_options_get(ssh_session session, enum ssh_options_e type,
500 LIBSSH_API
int ssh_pcap_file_close(ssh_pcap_file pcap);
501 LIBSSH_API
void ssh_pcap_file_free(ssh_pcap_file pcap);
502 LIBSSH_API ssh_pcap_file ssh_pcap_file_new(
void);
503 LIBSSH_API
int ssh_pcap_file_open(ssh_pcap_file pcap, const
char *filename);
518 typedef
int (*ssh_auth_callback) (const
char *prompt,
char *buf,
size_t len,
519 int echo,
int verify,
void *userdata);
523 LIBSSH_API enum ssh_keytypes_e
ssh_key_type(const ssh_key key);
530 enum ssh_keycmp_e what);
535 const
char *passphrase,
536 ssh_auth_callback auth_fn,
540 const
char *passphrase,
541 ssh_auth_callback auth_fn,
545 const
char *passphrase,
546 ssh_auth_callback auth_fn,
548 const
char *filename);
551 enum ssh_keytypes_e type,
560 LIBSSH_API
int ssh_pki_export_pubkey_file(const ssh_key key,
561 const
char *filename);
565 LIBSSH_API
void ssh_print_hexa(const
char *descr, const
unsigned char *what,
size_t len);
566 LIBSSH_API
int ssh_send_ignore (ssh_session session, const
char *data);
567 LIBSSH_API
int ssh_send_debug (ssh_session session, const
char *message,
int always_display);
568 LIBSSH_API
void ssh_gssapi_set_creds(ssh_session session, const ssh_gssapi_creds creds);
575 LIBSSH_API ssh_scp
ssh_scp_new(ssh_session session,
int mode, const
char *location);
578 LIBSSH_API
int ssh_scp_push_file(ssh_scp scp, const
char *filename,
size_t size,
int perms);
579 LIBSSH_API
int ssh_scp_push_file64(ssh_scp scp, const
char *filename, uint64_t size,
int perms);
580 LIBSSH_API
int ssh_scp_read(ssh_scp scp,
void *buffer,
size_t size);
586 LIBSSH_API
int ssh_scp_write(ssh_scp scp, const
void *buffer,
size_t len);
587 LIBSSH_API
int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd,
588 fd_set *readfds, struct timeval *timeout);
589 LIBSSH_API
int ssh_service_request(ssh_session session, const
char *service);
590 LIBSSH_API
int ssh_set_agent_channel(ssh_session session, ssh_channel channel);
593 ssh_counter rcounter);
598 LIBSSH_API
int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcapfile);
604 const
char *username,
605 const ssh_key pubkey);
607 const
char *username,
608 const ssh_key privkey);
611 const char *username);
614 const char *username,
615 const char *passphrase);
617 const char *username,
618 const char *password);
620 LIBSSH_API
int ssh_userauth_kbdint(ssh_session session,
const char *user,
const char *submethods);
630 LIBSSH_API
const char *
ssh_version(
int req_version);
636 LIBSSH_API
int ssh_string_fill(ssh_string str,
const void *data,
size_t len);
645 LIBSSH_API
int ssh_getpass(
const char *prompt,
char *buf,
size_t len,
int echo,
649 typedef int (*ssh_event_callback)(socket_t fd,
int revents,
void *userdata);
653 ssh_event_callback cb,
void *userdata);
667 #ifndef LIBSSH_LEGACY_0_4
668 #include "libssh/legacy.h"
int ssh_set_log_userdata(void *data)
Set the userdata for the logging function.
Definition: log.c:232
void * ssh_get_log_userdata(void)
Get the userdata of the logging function.
Definition: log.c:216
int ssh_pki_export_privkey_to_pubkey(const ssh_key privkey, ssh_key *pkey)
Create a public key from a private key.
Definition: pki.c:1101
int ssh_userauth_kbdint(ssh_session session, const char *user, const char *submethods)
Try to authenticate through the "keyboard-interactive" method.
Definition: auth.c:1519
int ssh_scp_init(ssh_scp scp)
Initialize the scp channel.
Definition: scp.c:95
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:2623
int ssh_options_get(ssh_session session, enum ssh_options_e type, char **value)
This function can get ssh options, it does not support all options provided for ssh options set...
Definition: options.c:946
int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash)
Definition: dh.c:889
char * ssh_string_to_char(struct ssh_string_struct *s)
Convert a SSH string to a C nul-terminated string.
Definition: string.c:176
int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, struct timeval *timeout)
Act like the standard select(2) on channels.
Definition: channels.c:3017
int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition: options.c:1206
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:1866
const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string.
Definition: pki.c:205
int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition: channels.c:1756
int ssh_init(void)
Initialize global cryptographic data structures.
Definition: init.c:53
int ssh_message_type(ssh_message msg)
Get the type of the message.
Definition: messages.c:463
int ssh_send_debug(ssh_session session, const char *message, int always_display)
Send a debug message.
Definition: session.c:853
const char * ssh_get_cipher_in(ssh_session session)
get the name of the input cipher for the given session.
Definition: session.c:355
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:939
int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition: channels.c:1414
int ssh_set_log_level(int level)
Set the log level of the library.
Definition: log.c:178
int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition: channels.c:1067
void ssh_scp_free(ssh_scp scp)
Free a scp context.
Definition: scp.c:199
void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash.
Definition: dh.c:935
int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition: channels.c:1119
int ssh_pki_export_privkey_file(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, const char *filename)
Export a private key to a pem file on disk, or OpenSSH format for keytype ssh-ed25519.
Definition: pki.c:548
void ssh_set_fd_toread(ssh_session session)
Tell the session it has data to read on the file descriptor without blocking.
Definition: session.c:530
int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key.
Definition: pki.c:269
int ssh_scp_leave_directory(ssh_scp scp)
Leave a directory.
Definition: scp.c:271
ssh_string ssh_string_new(size_t size)
Create a new SSH String object.
Definition: string.c:53
int ssh_scp_deny_request(ssh_scp scp, const char *reason)
Deny the transfer of a file or creation of a directory coming from the remote party.
Definition: scp.c:644
int ssh_key_is_private(const ssh_key k)
Check if the key is a private key.
Definition: pki.c:284
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:613
int ssh_channel_open_auth_agent(ssh_channel channel)
Open an agent authentication forwarding channel.
Definition: channels.c:895
const char * ssh_version(int req_version)
Check if libssh is the required version or get the version string.
Definition: misc.c:365
ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session.
Definition: messages.c:436
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
Lower level protocol infomations, packet level.
Definition: libssh.h:288
int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel.
Definition: channels.c:1371
int ssh_scp_accept_request(ssh_scp scp)
Accepts transfer of a file or creation of a directory coming from the remote party.
Definition: scp.c:673
int ssh_event_add_session(ssh_event event, ssh_session session)
remove the poll handle from session and assign them to a event, when used in blocking mode...
Definition: poll.c:783
int ssh_pki_export_pubkey_base64(const ssh_key key, char **b64_key)
Convert a public key to a base64 encoded key.
Definition: pki.c:1167
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:1620
int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp").
Definition: channels.c:1782
int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a keypair.
Definition: pki.c:1036
ssh_string ssh_string_from_char(const char *what)
Create a ssh string using a C string.
Definition: string.c:103
int ssh_getpass(const char *prompt, char *buf, size_t len, int echo, int verify)
Get a password from the console.
Definition: getpass.c:214
int ssh_event_dopoll(ssh_event event, int timeout)
Poll all the sockets and sessions associated through an event object.
Definition: poll.c:835
int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition: session.c:783
int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition: channels.c:2294
void ssh_set_fd_except(ssh_session session)
Tell the session it has an exception to catch on the file descriptor.
Definition: session.c:556
char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition: client.c:587
int ssh_string_fill(struct ssh_string_struct *s, const void *data, size_t len)
Fill a string with given data.
Definition: string.c:82
int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given.
Definition: auth.c:1567
int ssh_event_add_fd(ssh_event event, socket_t fd, short events, ssh_event_callback cb, void *userdata)
Add a fd to the event and assign it a callback, when used in blocking mode.
Definition: poll.c:741
void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters.
Definition: session.c:909
int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure.
Definition: options.c:64
const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block.
Definition: auth.c:1610
int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition: channels.c:862
uint64_t ssh_scp_request_get_size64(ssh_scp scp)
Get the size of the file being pushed from the other party.
Definition: scp.c:789
struct ssh_string_struct * ssh_string_copy(struct ssh_string_struct *s)
Copy a string, return a newly allocated string.
Definition: string.c:216
const char * ssh_string_get_char(struct ssh_string_struct *s)
Get the the string as a C nul-terminated string.
Definition: string.c:155
int ssh_userauth_kbdint_getnanswers(ssh_session session)
Get the number of answers the client has given.
Definition: auth.c:1673
void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode.
Definition: session.c:434
int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition: channels.c:1384
enum ssh_keytypes_e ssh_key_type_from_name(const char *name)
Convert a ssh key name to a ssh key type.
Definition: pki.c:232
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:1400
const char * ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i)
Get the answer for a question from a message block.
Definition: auth.c:1688
void ssh_key_free(ssh_key key)
deallocate a SSH key
Definition: pki.c:178
Only warnings.
Definition: libssh.h:282
Every function path.
Definition: libssh.h:291
ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel.
Definition: channels.c:2878
int ssh_channel_poll_timeout(ssh_channel channel, int timeout, int is_stderr)
Polls a channel for data to read, waiting for a certain timeout.
Definition: channels.c:2837
const char * ssh_pki_key_ecdsa_name(const ssh_key key)
returns the ECDSA key name ("ecdsa-sha2-nistp256" for example)
Definition: pki.c:110
ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location)
Create a new scp session.
Definition: scp.c:60
const char * ssh_scp_request_get_filename(ssh_scp scp)
Get the name of the directory or file being pushed from the other party.
Definition: scp.c:754
int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len)
Write into a remote scp file.
Definition: scp.c:437
ssh_event ssh_event_new(void)
Create a new event context.
Definition: poll.c:686
int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition: channels.c:2785
int ssh_is_connected(ssh_session session)
Check if we are connected.
Definition: session.c:498
int ssh_get_log_level(void)
Get the log level of the library.
Definition: log.c:193
int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop.
Definition: session.c:738
int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method.
Definition: auth.c:1765
No logging at all.
Definition: libssh.h:279
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:388
int ssh_options_getopt(ssh_session session, int *argcptr, char **argv)
Parse command line arguments.
Definition: options.c:1018
const char * ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, char *echo)
Get a prompt from a message block.
Definition: auth.c:1645
const char * ssh_userauth_kbdint_getname(ssh_session session)
Get the "name" of the message block.
Definition: auth.c:1588
const char * ssh_get_clientbanner(ssh_session session)
get the client banner
Definition: session.c:297
int ssh_event_remove_session(ssh_event event, ssh_session session)
Remove a session object from an event context.
Definition: poll.c:900
ssh_key ssh_key_new(void)
creates a new empty SSH key
Definition: pki.c:124
int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition: auth.c:1105
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:888
int ssh_userauth_kbdint_setanswer(ssh_session session, unsigned int i, const char *answer)
Set the answer for a question from a message block.
Definition: auth.c:1719
int ssh_userauth_publickey(ssh_session session, const char *username, const ssh_key privkey)
Authenticate with public/private key.
Definition: auth.c:550
const char * ssh_get_cipher_out(ssh_session session)
get the name of the output cipher for the given session.
Definition: session.c:371
int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd, fd_set *readfds, struct timeval *timeout)
A wrapper for the select syscall.
Definition: connect.c:451
socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition: session.c:516
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:1709
int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition: client.c:469
enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key
Definition: pki.c:191
void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server).
Definition: client.c:627
int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method.
Definition: auth.c:354
void ssh_string_free(struct ssh_string_struct *s)
Deallocate a SSH string object.
Definition: string.c:272
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:2167
ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition: channels.c:1982
int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname.
Definition: misc.c:622
int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer.
Definition: session.c:473
int ssh_key_cmp(const ssh_key k1, const ssh_key k2, enum ssh_keycmp_e what)
Compare keys if they are equal.
Definition: pki.c:303
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:2439
void ssh_set_fd_towrite(ssh_session session)
Tell the session it may write to the file descriptor without blocking.
Definition: session.c:543
void ssh_event_free(ssh_event event)
Free an event context.
Definition: poll.c:946
High level protocol information.
Definition: libssh.h:285
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:2225
void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len)
Print a buffer as colon separated hex string.
Definition: dh.c:1111
const char * ssh_scp_request_get_warning(ssh_scp scp)
Get the warning string from a scp handle.
Definition: scp.c:829
int ssh_options_get_port(ssh_session session, unsigned int *port_target)
This function can get ssh the ssh port.
Definition: options.c:890
int ssh_scp_request_get_permissions(ssh_scp scp)
Get the permissions of the directory or file being pushed from the other party.
Definition: scp.c:766
size_t ssh_scp_request_get_size(ssh_scp scp)
Get the size of the file being pushed from the other party.
Definition: scp.c:779
void * ssh_string_data(struct ssh_string_struct *s)
Get the payload of the string.
Definition: string.c:259
int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port)
Open a X11 channel.
Definition: channels.c:3263
int ssh_scp_read(ssh_scp scp, void *buffer, size_t size)
Read from a remote scp file.
Definition: scp.c:703
char * ssh_basename(const char *path)
basename - parse filename component.
Definition: misc.c:571
int ssh_finalize(void)
Finalize and cleanup all libssh and cryptographic data structures.
Definition: init.c:73
void ssh_string_burn(struct ssh_string_struct *s)
Destroy the data in a string so it couldn't appear in a core dump.
Definition: string.c:244
int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition: channels.c:2364
const char * ssh_get_hmac_out(ssh_session session)
get the name of the output HMAC algorithm for the given session.
Definition: session.c:402
int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition: channels.c:1690
const char * ssh_get_serverbanner(ssh_session session)
get the server banner
Definition: session.c:312
void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition: session.c:417
const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition: session.c:758
size_t ssh_string_len(struct ssh_string_struct *s)
Return the size of a SSH string.
Definition: string.c:131
void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode.
Definition: channels.c:1439
const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm.
Definition: session.c:326
void ssh_message_free(ssh_message msg)
Free a SSH message.
Definition: messages.c:502
int ssh_message_subtype(ssh_message msg)
Get the subtype of the message.
Definition: messages.c:478
ssh_session ssh_new(void)
Create a new ssh session.
Definition: session.c:58
int ssh_get_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session.
Definition: dh.c:952
int ssh_get_status(ssh_session session)
Get session status.
Definition: session.c:700
void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter.
Definition: channels.c:3151
void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition: channels.c:995
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_event_remove_fd(ssh_event event, socket_t fd)
Remove a socket fd from an event context.
Definition: poll.c:854
int ssh_scp_push_file64(ssh_scp scp, const char *filename, uint64_t size, int perms)
Initialize the sending of a file to a scp in sink mode, using a 64-bit size.
Definition: scp.c:317
int ssh_scp_pull_request(ssh_scp scp)
Wait for a scp request (file, directory).
Definition: scp.c:547
void ssh_string_free_char(char *s)
Deallocate a char string object.
Definition: string.c:204
int ssh_is_server_known(ssh_session session)
Check if the server is known.
Definition: known_hosts.c:406
int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored.
Definition: session.c:818
int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh.
Definition: session.c:448
char * ssh_get_hexa(const unsigned char *what, size_t len)
Convert a buffer into a colon separated hex string.
Definition: dh.c:1077
int ssh_get_publickey_hash(const ssh_key key, enum ssh_publickey_hash_type type, unsigned char **hash, size_t *hlen)
Allocates a buffer with the hash of the public key.
Definition: dh.c:992
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:2914
int ssh_pki_import_pubkey_file(const char *filename, ssh_key *pkey)
Import a public key from the given filename.
Definition: pki.c:944
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:2244
int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent.
Definition: auth.c:766
const char * ssh_get_hmac_in(ssh_session session)
get the name of the input HMAC algorithm for the given session.
Definition: session.c:387
int ssh_scp_push_file(ssh_scp scp, const char *filename, size_t size, int perms)
Initialize the sending of a file to a scp in sink mode.
Definition: scp.c:372
int ssh_pki_import_pubkey_base64(const char *b64_key, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formated public key from a memory c-string.
Definition: pki.c:838
int ssh_scp_push_directory(ssh_scp scp, const char *dirname, int mode)
Create a directory in a scp in sink mode.
Definition: scp.c:227
int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr)
Reads data from a channel.
Definition: channels.c:2595
int ssh_pki_import_privkey_base64(const char *b64_key, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, ssh_key *pkey)
import a base64 formated key from a memory c-string
Definition: pki.c:398
void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition: session.c:172
int ssh_scp_close(ssh_scp scp)
Close the scp channel.
Definition: scp.c:161
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:2733
char * ssh_dirname(const char *path)
Parse directory component.
Definition: misc.c:516
int ssh_get_error_code(void *error)
Retrieve the error code from the last error.
Definition: error.c:131
int ssh_pki_import_privkey_file(const char *filename, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, ssh_key *pkey)
Import a key from a file.
Definition: pki.c:461