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;
    61   #include <sys/types.h>    67  #include <sys/select.h>     71 #define SSH_STRINGIFY(s) SSH_TOSTRING(s)    72 #define SSH_TOSTRING(s) #s    75 #define SSH_VERSION_INT(a, b, c) ((a) << 16 | (b) << 8 | (c))    76 #define SSH_VERSION_DOT(a, b, c) a ##.## b ##.## c    77 #define SSH_VERSION(a, b, c) SSH_VERSION_DOT(a, b, c)    80 #define LIBSSH_VERSION_MAJOR  0    81 #define LIBSSH_VERSION_MINOR  8    82 #define LIBSSH_VERSION_MICRO  2    84 #define LIBSSH_VERSION_INT SSH_VERSION_INT(LIBSSH_VERSION_MAJOR, \    85                                            LIBSSH_VERSION_MINOR, \    87 #define LIBSSH_VERSION     SSH_VERSION(LIBSSH_VERSION_MAJOR, \    88                                        LIBSSH_VERSION_MINOR, \    93 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))    95 #define PRINTF_ATTRIBUTE(a,b)    99 #define SSH_DEPRECATED __attribute__ ((deprecated))   101 #define SSH_DEPRECATED   112     uint64_t out_packets;
   120 typedef struct ssh_pcap_file_struct* ssh_pcap_file;
   127 typedef void* ssh_gssapi_creds;
   132 typedef SOCKET socket_t;
   136 typedef int socket_t;
   140 #define SSH_INVALID_SOCKET ((socket_t) -1)   143 enum ssh_kex_types_e {
   171 #define SSH_AUTH_METHOD_UNKNOWN 0   172 #define SSH_AUTH_METHOD_NONE 0x0001   173 #define SSH_AUTH_METHOD_PASSWORD 0x0002   174 #define SSH_AUTH_METHOD_PUBLICKEY 0x0004   175 #define SSH_AUTH_METHOD_HOSTBASED 0x0008   176 #define SSH_AUTH_METHOD_INTERACTIVE 0x0010   177 #define SSH_AUTH_METHOD_GSSAPI_MIC 0x0020   180 enum ssh_requests_e {
   182     SSH_REQUEST_CHANNEL_OPEN,
   188 enum ssh_channel_type_e {
   189     SSH_CHANNEL_UNKNOWN=0,
   191     SSH_CHANNEL_DIRECT_TCPIP,
   192     SSH_CHANNEL_FORWARDED_TCPIP,
   194     SSH_CHANNEL_AUTH_AGENT
   197 enum ssh_channel_requests_e {
   198     SSH_CHANNEL_REQUEST_UNKNOWN=0,
   199     SSH_CHANNEL_REQUEST_PTY,
   200     SSH_CHANNEL_REQUEST_EXEC,
   201     SSH_CHANNEL_REQUEST_SHELL,
   202     SSH_CHANNEL_REQUEST_ENV,
   203     SSH_CHANNEL_REQUEST_SUBSYSTEM,
   204     SSH_CHANNEL_REQUEST_WINDOW_CHANGE,
   205     SSH_CHANNEL_REQUEST_X11
   208 enum ssh_global_requests_e {
   209     SSH_GLOBAL_REQUEST_UNKNOWN=0,
   210     SSH_GLOBAL_REQUEST_TCPIP_FORWARD,
   211     SSH_GLOBAL_REQUEST_CANCEL_TCPIP_FORWARD,
   212     SSH_GLOBAL_REQUEST_KEEPALIVE
   215 enum ssh_publickey_state_e {
   216     SSH_PUBLICKEY_STATE_ERROR=-1,
   217     SSH_PUBLICKEY_STATE_NONE=0,
   218     SSH_PUBLICKEY_STATE_VALID=1,
   219     SSH_PUBLICKEY_STATE_WRONG=2
   224 #define SSH_CLOSED 0x01   226 #define SSH_READ_PENDING 0x02   228 #define SSH_CLOSED_ERROR 0x04   230 #define SSH_WRITE_PENDING 0x08   232 enum ssh_server_known_e {
   234     SSH_SERVER_NOT_KNOWN=0,
   236     SSH_SERVER_KNOWN_CHANGED,
   237     SSH_SERVER_FOUND_OTHER,
   238     SSH_SERVER_FILE_NOT_FOUND
   241 enum ssh_known_hosts_e {
   245     SSH_KNOWN_HOSTS_ERROR = -2,
   251     SSH_KNOWN_HOSTS_NOT_FOUND = -1,
   257     SSH_KNOWN_HOSTS_UNKNOWN = 0,
   269     SSH_KNOWN_HOSTS_CHANGED,
   275     SSH_KNOWN_HOSTS_OTHER,
   278 #ifndef MD5_DIGEST_LEN   279     #define MD5_DIGEST_LEN 16   283 enum ssh_error_types_e {
   292   SSH_KEYTYPE_UNKNOWN=0,
   298   SSH_KEYTYPE_DSS_CERT01,
   299   SSH_KEYTYPE_RSA_CERT01
   303   SSH_KEY_CMP_PUBLIC = 0,
   307 #define SSH_ADDRSTRLEN 46   347 #define SSH_LOG_RARE SSH_LOG_WARNING   357 #define SSH_LOG_NONE 0   359 #define SSH_LOG_WARN 1   361 #define SSH_LOG_INFO 2   363 #define SSH_LOG_DEBUG 3   365 #define SSH_LOG_TRACE 4   372   SSH_OPTIONS_PORT_STR,
   376   SSH_OPTIONS_IDENTITY,
   377   SSH_OPTIONS_ADD_IDENTITY,
   378   SSH_OPTIONS_KNOWNHOSTS,
   380   SSH_OPTIONS_TIMEOUT_USEC,
   383   SSH_OPTIONS_LOG_VERBOSITY,
   384   SSH_OPTIONS_LOG_VERBOSITY_STR,
   385   SSH_OPTIONS_CIPHERS_C_S,
   386   SSH_OPTIONS_CIPHERS_S_C,
   387   SSH_OPTIONS_COMPRESSION_C_S,
   388   SSH_OPTIONS_COMPRESSION_S_C,
   389   SSH_OPTIONS_PROXYCOMMAND,
   390   SSH_OPTIONS_BINDADDR,
   391   SSH_OPTIONS_STRICTHOSTKEYCHECK,
   392   SSH_OPTIONS_COMPRESSION,
   393   SSH_OPTIONS_COMPRESSION_LEVEL,
   394   SSH_OPTIONS_KEY_EXCHANGE,
   395   SSH_OPTIONS_HOSTKEYS,
   396   SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
   397   SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
   398   SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
   399   SSH_OPTIONS_HMAC_C_S,
   400   SSH_OPTIONS_HMAC_S_C,
   401   SSH_OPTIONS_PASSWORD_AUTH,
   402   SSH_OPTIONS_PUBKEY_AUTH,
   403   SSH_OPTIONS_KBDINT_AUTH,
   404   SSH_OPTIONS_GSSAPI_AUTH,
   405   SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
   414   SSH_SCP_RECURSIVE=0x10
   417 enum ssh_scp_request_types {
   419   SSH_SCP_REQUEST_NEWDIR=1,
   421   SSH_SCP_REQUEST_NEWFILE,
   425   SSH_SCP_REQUEST_ENDDIR,
   427   SSH_SCP_REQUEST_WARNING
   430 enum ssh_connector_flags_e {
   432     SSH_CONNECTOR_STDOUT = 1,
   434     SSH_CONNECTOR_STDERR = 2,
   436     SSH_CONNECTOR_BOTH = 3
   452     int remoteport, 
const char *sourcehost, 
int localport);
   454 LIBSSH_API 
int ssh_channel_open_x11(
ssh_channel channel, 
const char *orig_addr, 
int orig_port);
   469 LIBSSH_API 
int ssh_channel_request_sftp(
ssh_channel channel);
   472     const char *cookie, 
int screen_number);
   492 LIBSSH_API 
int ssh_connector_set_in_channel(
ssh_connector connector,
   494                                             enum ssh_connector_flags_e flags);
   495 LIBSSH_API 
int ssh_connector_set_out_channel(
ssh_connector connector,
   497                                              enum ssh_connector_flags_e flags);
   498 LIBSSH_API 
void ssh_connector_set_in_fd(
ssh_connector connector, socket_t fd);
   499 LIBSSH_API 
void ssh_connector_set_out_fd(
ssh_connector connector, socket_t fd);
   501 LIBSSH_API 
const char *ssh_copyright(
void);
   509                                                   int *destination_port);
   523 LIBSSH_API 
char *
ssh_get_hexa(
const unsigned char *what, 
size_t len);
   529 enum ssh_publickey_hash_type {
   530     SSH_PUBLICKEY_HASH_SHA1,
   531     SSH_PUBLICKEY_HASH_MD5,
   532     SSH_PUBLICKEY_HASH_SHA256
   535                                       enum ssh_publickey_hash_type type,
   536                                       unsigned char **hash,
   542 SSH_DEPRECATED LIBSSH_API 
int ssh_forward_cancel(
ssh_session session, 
const char *address, 
int port);
   543 SSH_DEPRECATED LIBSSH_API 
int ssh_forward_listen(
ssh_session session, 
const char *address, 
int port, 
int *bound_port);
   547 LIBSSH_API 
int ssh_get_random(
void *where,
int len,
int strong);
   558 #define SSH_KNOWNHOSTS_ENTRY_FREE(e) do { \   560     ssh_knownhosts_entry_free(e); \   571                                                     char **pentry_string);
   574 LIBSSH_API 
enum ssh_known_hosts_e
   584 LIBSSH_API 
void _ssh_log(
int verbosity,
   585                          const char *
function,
   586                          const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
   589 SSH_DEPRECATED LIBSSH_API 
void ssh_log(
ssh_session session,
   591                                        const 
char *format, ...) PRINTF_ATTRIBUTE(3, 4);
   594 LIBSSH_API 
int ssh_message_channel_request_reply_success(
ssh_message msg);
   599 LIBSSH_API 
int ssh_mkdir (const 
char *pathname, mode_t mode);
   610 LIBSSH_API 
int ssh_pcap_file_close(ssh_pcap_file pcap);
   611 LIBSSH_API 
void ssh_pcap_file_free(ssh_pcap_file pcap);
   612 LIBSSH_API ssh_pcap_file ssh_pcap_file_new(
void);
   613 LIBSSH_API 
int ssh_pcap_file_open(ssh_pcap_file pcap, const 
char *filename);
   628 typedef 
int (*ssh_auth_callback) (const 
char *prompt, 
char *buf, 
size_t len,
   629     int echo, 
int verify, 
void *userdata);
   640                            enum ssh_keycmp_e what);
   645                                              const 
char *passphrase,
   646                                              ssh_auth_callback auth_fn,
   650                                            const 
char *passphrase,
   651                                            ssh_auth_callback auth_fn,
   655                                            const 
char *passphrase,
   656                                            ssh_auth_callback auth_fn,
   658                                            const 
char *filename);
   664                                             enum ssh_keytypes_e type,
   670                                           enum ssh_keytypes_e type,
   679 LIBSSH_API 
int ssh_pki_export_pubkey_file(const 
ssh_key key,
   680                                           const 
char *filename);
   684 LIBSSH_API 
void ssh_print_hash(enum ssh_publickey_hash_type type, 
unsigned char *hash, 
size_t len);
   685 LIBSSH_API 
void ssh_print_hexa(const 
char *descr, const 
unsigned char *what, 
size_t len);
   688 LIBSSH_API 
void ssh_gssapi_set_creds(
ssh_session session, const ssh_gssapi_creds creds);
   708     fd_set *readfds, struct timeval *timeout);
   711 LIBSSH_API 
int ssh_set_agent_socket(
ssh_session session, socket_t fd);
   719 LIBSSH_API 
int ssh_set_pcap_file(
ssh_session session, ssh_pcap_file pcapfile);
   725                                           const 
char *username,
   728                                       const 
char *username,
   732                                   const char *username);
   735                                            const char *username,
   736                                            const char *passphrase);
   738                                      const char *username,
   739                                      const char *password);
   746 LIBSSH_API 
int ssh_userauth_kbdint_getnanswers(
ssh_session session);
   747 LIBSSH_API 
const char *ssh_userauth_kbdint_getanswer(
ssh_session session, 
unsigned int i);
   751 LIBSSH_API 
const char *
ssh_version(
int req_version);
   767 LIBSSH_API 
int ssh_getpass(
const char *prompt, 
char *buf, 
size_t len, 
int echo,
   771 typedef int (*ssh_event_callback)(socket_t fd, 
int revents, 
void *userdata);
   775                                     ssh_event_callback cb, 
void *userdata);
   799 #ifndef LIBSSH_LEGACY_0_4   800 #include "libssh/legacy.h" LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry)
Free an allocated ssh_knownhosts_entry. 
Definition: knownhosts.c:144
LIBSSH_API int ssh_set_log_userdata(void *data)
Set the userdata for the logging function. 
Definition: log.c:235
Definition: messages.h:46
LIBSSH_API void * ssh_get_log_userdata(void)
Get the userdata of the logging function. 
Definition: log.c:219
LIBSSH_API 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:1255
LIBSSH_API int ssh_userauth_kbdint(ssh_session session, const char *user, const char *submethods)
Try to authenticate through the "keyboard-interactive" method. 
Definition: auth.c:1572
LIBSSH_API int ssh_scp_init(ssh_scp scp)
Initialize the scp channel. 
Definition: scp.c:95
LIBSSH_API enum ssh_known_hosts_e ssh_session_get_known_hosts_entry(ssh_session session, struct ssh_knownhosts_entry **pentry)
Get the known_hosts entry for the current connected session. 
Definition: knownhosts.c:824
LIBSSH_API 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:1001
SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash)
Definition: dh.c:945
char * ssh_string_to_char(struct ssh_string_struct *s)
Convert a SSH string to a C nul-terminated string. 
Definition: string.c:176
LIBSSH_API 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:3054
LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file. 
Definition: options.c:1255
LIBSSH_API 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:1846
LIBSSH_API const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string. 
Definition: pki.c:203
LIBSSH_API int ssh_channel_request_shell(ssh_channel channel)
Request a shell. 
Definition: channels.c:1735
LIBSSH_API int ssh_init(void)
Initialize global cryptographic data structures. 
Definition: init.c:148
LIBSSH_API int ssh_message_type(ssh_message msg)
Get the type of the message. 
Definition: messages.c:509
LIBSSH_API int ssh_send_debug(ssh_session session, const char *message, int always_display)
Send a debug message. 
Definition: session.c:866
LIBSSH_API const char * ssh_get_cipher_in(ssh_session session)
get the name of the input cipher for the given session. 
Definition: session.c:368
LIBSSH_API 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:923
LIBSSH_API int ssh_channel_request_send_break(ssh_channel channel, uint32_t length)
Send a break signal to the server (as described in RFC 4335). 
Definition: channels.c:2485
Definition: messages.h:84
LIBSSH_API int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF. 
Definition: channels.c:1412
LIBSSH_API int ssh_known_hosts_parse_line(const char *host, const char *line, struct ssh_knownhosts_entry **entry)
Parse a line from a known_hosts entry into a structure. 
Definition: knownhosts.c:386
LIBSSH_API 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:2660
LIBSSH_API int ssh_set_log_level(int level)
Set the log level of the library. 
Definition: log.c:181
LIBSSH_API int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel. 
Definition: channels.c:1054
Definition: channels.h:57
void ssh_buffer_free(struct ssh_buffer_struct *buffer)
Deallocate a SSH buffer. 
Definition: buffer.c:102
LIBSSH_API void ssh_scp_free(ssh_scp scp)
Free a scp context. 
Definition: scp.c:199
LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash. 
Definition: dh.c:1007
LIBSSH_API int ssh_channel_close(ssh_channel channel)
Close a channel. 
Definition: channels.c:1106
LIBSSH_API 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:566
LIBSSH_API 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:543
LIBSSH_API int ssh_session_export_known_hosts_entry(ssh_session session, char **pentry_string)
Export the current session information to a known_hosts string. 
Definition: knownhosts.c:597
LIBSSH_API int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key. 
Definition: pki.c:270
LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel)
Get the remote window size. 
Definition: channels.c:1352
LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp)
Leave a directory. 
Definition: scp.c:271
LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector)
Remove a connector from an event context. 
Definition: poll.c:1003
LIBSSH_API ssh_string ssh_string_new(size_t size)
Create a new SSH String object. 
Definition: string.c:53
LIBSSH_API 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
LIBSSH_API int ssh_key_is_private(const ssh_key k)
Check if the key is a private key. 
Definition: pki.c:285
LIBSSH_API 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:629
LIBSSH_API int ssh_channel_open_auth_agent(ssh_channel channel)
Open an agent authentication forwarding channel. This type of channel can be opened by a server towar...
Definition: channels.c:885
LIBSSH_API const char * ssh_version(int req_version)
Check if libssh is the required version or get the version string. 
Definition: misc.c:356
LIBSSH_API ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session. 
Definition: messages.c:482
LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server. 
Definition: auth.c:355
LIBSSH_API void ssh_print_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len)
Print a hash as a human-readable hex- or base64-string. 
Definition: dh.c:1285
LIBSSH_API const char * ssh_get_error(void *error)
Retrieve the error text message from the last error. 
Definition: error.c:128
LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel. 
Definition: channels.c:1369
LIBSSH_API 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
LIBSSH_API 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:812
LIBSSH_API 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:1323
LIBSSH_API 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:1614
LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp"). 
Definition: channels.c:1757
LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a keypair. 
Definition: pki.c:1187
Definition: connector.c:45
LIBSSH_API ssh_string ssh_string_from_char(const char *what)
Create a ssh string using a C string. 
Definition: string.c:103
LIBSSH_API 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
LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout)
Poll all the sockets and sessions associated through an event object.i. 
Definition: poll.c:884
LIBSSH_API int ssh_get_version(ssh_session session)
Get the protocol version of the session. 
Definition: session.c:796
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables. 
Definition: channels.c:2299
LIBSSH_API void ssh_set_fd_except(ssh_session session)
Tell the session it has an exception to catch on the file descriptor. 
Definition: session.c:569
uint32_t ssh_buffer_get_len(struct ssh_buffer_struct *buffer)
Get the length of the buffer from the current position. 
Definition: buffer.c:527
LIBSSH_API char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server. 
Definition: client.c:603
int ssh_buffer_reinit(struct ssh_buffer_struct *buffer)
Reinitialize a SSH buffer. 
Definition: buffer.c:195
LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session)
Check if the set hostname and port matches an entry in known_hosts. 
Definition: knownhosts.c:534
LIBSSH_API int ssh_pki_copy_cert_to_privkey(const ssh_key cert_key, ssh_key privkey)
Copy the certificate part of a public key into a private key. 
Definition: pki.c:1416
int ssh_string_fill(struct ssh_string_struct *s, const void *data, size_t len)
Fill a string with given data. The string should be big enough. 
Definition: string.c:82
LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given. 
Definition: auth.c:1615
LIBSSH_API 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:743
LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters. 
Definition: session.c:922
LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure. 
Definition: options.c:64
LIBSSH_API const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block. 
Definition: auth.c:1660
LIBSSH_API int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding). 
Definition: channels.c:858
LIBSSH_API 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. The caller has to free the 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
void * ssh_buffer_get(struct ssh_buffer_struct *buffer)
Get a pointer to the head of a buffer at the current position. 
Definition: buffer.c:514
LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode. 
Definition: session.c:447
LIBSSH_API int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not. 
Definition: channels.c:1382
LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector)
Add a connector to the SSH event loop. 
Definition: poll.c:864
LIBSSH_API 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:233
LIBSSH_API int ssh_write_knownhost(ssh_session session)
This function is deprecated. 
Definition: known_hosts.c:519
LIBSSH_API int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not. 
Definition: channels.c:1398
LIBSSH_API void ssh_key_free(ssh_key key)
deallocate a SSH key 
Definition: pki.c:174
LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel. 
Definition: channels.c:2915
LIBSSH_API 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:2874
LIBSSH_API const char * ssh_pki_key_ecdsa_name(const ssh_key key)
returns the ECDSA key name ("ecdsa-sha2-nistp256" for example) 
Definition: pki.c:92
LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location)
Create a new scp session. 
Definition: scp.c:60
LIBSSH_API ssh_buffer ssh_buffer_new(void)
Create a new SSH buffer. 
Definition: buffer.c:86
LIBSSH_API 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
LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len)
Write into a remote scp file. 
Definition: scp.c:437
LIBSSH_API ssh_event ssh_event_new(void)
Create a new event context. It could be associated with many ssh_session objects and socket fd which ...
Definition: poll.c:688
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read. 
Definition: channels.c:2822
LIBSSH_API int ssh_is_connected(ssh_session session)
Check if we are connected. 
Definition: session.c:511
LIBSSH_API int ssh_get_log_level(void)
Get the log level of the library. 
Definition: log.c:196
LIBSSH_API int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop. 
Definition: session.c:751
LIBSSH_API int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method. 
Definition: auth.c:1817
LIBSSH_API ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel. 
Definition: channels.c:79
LIBSSH_API 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:417
LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv)
Parse command line arguments. 
Definition: options.c:1073
LIBSSH_API const char * ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, char *echo)
Get a prompt from a message block. 
Definition: auth.c:1695
LIBSSH_API const char * ssh_userauth_kbdint_getname(ssh_session session)
Get the "name" of the message block. 
Definition: auth.c:1637
LIBSSH_API const char * ssh_get_clientbanner(ssh_session session)
get the client banner 
Definition: session.c:304
LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session)
Remove a session object from an event context. 
Definition: poll.c:949
LIBSSH_API ssh_key ssh_key_new(void)
creates a new empty SSH key 
Definition: pki.c:106
LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session. 
Definition: dh.c:1024
LIBSSH_API int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password. 
Definition: auth.c:1156
LIBSSH_API 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:936
LIBSSH_API 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:1770
LIBSSH_API int ssh_userauth_publickey(ssh_session session, const char *username, const ssh_key privkey)
Authenticate with public/private key or certificate. 
Definition: auth.c:572
LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formated certificate from a memory c-string. 
Definition: pki.c:1127
LIBSSH_API const char * ssh_get_cipher_out(ssh_session session)
get the name of the output cipher for the given session. 
Definition: session.c:384
LIBSSH_API 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:470
LIBSSH_API socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection. 
Definition: session.c:529
LIBSSH_API 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:1696
LIBSSH_API int ssh_connect(ssh_session session)
Connect to the ssh server. 
Definition: client.c:488
LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key 
Definition: pki.c:189
LIBSSH_API void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server). The session can then be reused to open a new session...
Definition: client.c:643
LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method. 
Definition: auth.c:385
void ssh_string_free(struct ssh_string_struct *s)
Deallocate a SSH string object. 
Definition: string.c:272
LIBSSH_API 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:2166
LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel. 
Definition: channels.c:1962
LIBSSH_API int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname. 
Definition: misc.c:632
LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer. 
Definition: session.c:486
LIBSSH_API 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:304
LIBSSH_API 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
LIBSSH_API void ssh_set_fd_towrite(ssh_session session)
Tell the session it may write to the file descriptor without blocking. 
Definition: session.c:556
LIBSSH_API void ssh_event_free(ssh_event event)
Free an event context. 
Definition: poll.c:1016
LIBSSH_API char * ssh_dump_knownhost(ssh_session session)
This function is deprecated. 
Definition: known_hosts.c:450
LIBSSH_API 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:2229
LIBSSH_API 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:1329
LIBSSH_API const char * ssh_scp_request_get_warning(ssh_scp scp)
Get the warning string from a scp handle. 
Definition: scp.c:829
LIBSSH_API int ssh_options_get_port(ssh_session session, unsigned int *port_target)
This function can get ssh the ssh port. It must only be used on a valid ssh session. This function is useful when the session options have been automatically inferred from the environment or configuration files and one. 
Definition: options.c:949
LIBSSH_API int ssh_pki_import_cert_file(const char *filename, ssh_key *pkey)
Import a certificate from the given filename. 
Definition: pki.c:1166
LIBSSH_API 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
LIBSSH_API 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
uint32_t ssh_buffer_get_data(struct ssh_buffer_struct *buffer, void *data, uint32_t len)
Get the remaining data out of the buffer and adjust the read pointer. 
Definition: buffer.c:596
LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size)
Read from a remote scp file. 
Definition: scp.c:703
LIBSSH_API char * ssh_basename(const char *path)
basename - parse filename component. 
Definition: misc.c:581
LIBSSH_API int ssh_finalize(void)
Finalize and cleanup all libssh and cryptographic data structures. 
Definition: init.c:221
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
LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell. 
Definition: channels.c:2369
LIBSSH_API const char * ssh_get_hmac_out(ssh_session session)
get the name of the output HMAC algorithm for the given session. 
Definition: session.c:415
LIBSSH_API int ssh_channel_request_pty(ssh_channel channel)
Request a PTY. 
Definition: channels.c:1677
LIBSSH_API const char * ssh_get_serverbanner(ssh_session session)
get the server banner 
Definition: session.c:319
LIBSSH_API enum ssh_known_hosts_e ssh_session_is_known_server(ssh_session session)
Check if the servers public key for the connected session is known. 
Definition: knownhosts.c:889
LIBSSH_API int ssh_session_update_known_hosts(ssh_session session)
Add the current connected server to the known_hosts file. 
Definition: knownhosts.c:669
LIBSSH_API void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket. 
Definition: session.c:430
LIBSSH_API const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server. 
Definition: session.c:771
size_t ssh_string_len(struct ssh_string_struct *s)
Return the size of a SSH string. 
Definition: string.c:131
LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode. 
Definition: channels.c:1437
LIBSSH_API const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm. 
Definition: session.c:333
LIBSSH_API void ssh_message_free(ssh_message msg)
Free a SSH message. 
Definition: messages.c:548
LIBSSH_API int ssh_message_subtype(ssh_message msg)
Get the subtype of the message. 
Definition: messages.c:524
LIBSSH_API ssh_session ssh_new(void)
Create a new ssh session. 
Definition: session.c:58
SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key)
Definition: dh.c:1074
LIBSSH_API int ssh_get_status(ssh_session session)
Get session status. 
Definition: session.c:713
LIBSSH_API void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter. 
Definition: channels.c:3188
LIBSSH_API void ssh_channel_free(ssh_channel channel)
Close and free a channel. 
Definition: channels.c:979
LIBSSH_API 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:468
LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd)
Remove a socket fd from an event context. 
Definition: poll.c:903
LIBSSH_API 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
LIBSSH_API int ssh_scp_pull_request(ssh_scp scp)
Wait for a scp request (file, directory). 
Definition: scp.c:547
LIBSSH_API void ssh_string_free_char(char *s)
Deallocate a char string object. 
Definition: string.c:204
LIBSSH_API int ssh_is_server_known(ssh_session session)
This function is depcrecated. 
Definition: known_hosts.c:312
LIBSSH_API int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored. 
Definition: session.c:831
LIBSSH_API int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh. 
Definition: session.c:461
LIBSSH_API char * ssh_get_hexa(const unsigned char *what, size_t len)
Convert a buffer into a colon separated hex string. The caller has to free the memory. 
Definition: dh.c:1247
LIBSSH_API 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:1107
LIBSSH_API 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:2951
LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename, ssh_key *pkey)
Import a public key from the given filename. 
Definition: pki.c:1026
LIBSSH_API 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:2248
LIBSSH_API int ssh_channel_request_auth_agent(ssh_channel channel)
Send an "auth-agent-req" channel request over an existing session channel. 
Definition: channels.c:1977
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:3208
LIBSSH_API int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent. 
Definition: auth.c:801
LIBSSH_API const char * ssh_get_hmac_in(ssh_session session)
get the name of the input HMAC algorithm for the given session. 
Definition: session.c:400
LIBSSH_API 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
LIBSSH_API 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:910
LIBSSH_API 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
LIBSSH_API int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr)
Reads data from a channel. 
Definition: channels.c:2632
LIBSSH_API 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:408
LIBSSH_API void ssh_free(ssh_session session)
Deallocate a SSH session handle. 
Definition: session.c:169
LIBSSH_API int ssh_scp_close(ssh_scp scp)
Close the scp channel. 
Definition: scp.c:161
LIBSSH_API 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:2770
int ssh_buffer_add_data(struct ssh_buffer_struct *buffer, const void *data, uint32_t len)
Add data at the tail of a buffer. 
Definition: buffer.c:225
LIBSSH_API char * ssh_dirname(const char *path)
Parse directory component. 
Definition: misc.c:526
LIBSSH_API int ssh_get_error_code(void *error)
Retrieve the error code from the last error. 
Definition: error.c:148
LIBSSH_API 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:472