24#include <libssh/libssh_version.h> 
   26#if defined _WIN32 || defined __CYGWIN__ 
   32        #define LIBSSH_API __attribute__((dllexport)) 
   34        #define LIBSSH_API __declspec(dllexport) 
   38        #define LIBSSH_API __attribute__((dllimport)) 
   40        #define LIBSSH_API __declspec(dllimport) 
   45  #if __GNUC__ >= 4 && !defined(__OS2__) 
   46    #define LIBSSH_API __attribute__((visibility("default"))) 
   60  #include <sys/types.h> 
   66 #include <sys/select.h>  
   70#define SSH_STRINGIFY(s) SSH_TOSTRING(s) 
   71#define SSH_TOSTRING(s) #s 
   75#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b))) 
   77#define PRINTF_ATTRIBUTE(a,b) 
   80#if !defined(SSH_SUPPRESS_DEPRECATED) && defined(__GNUC__) 
   81#define SSH_DEPRECATED __attribute__ ((deprecated)) 
   90struct ssh_counter_struct {
 
   96typedef struct ssh_counter_struct *ssh_counter;
 
   98typedef struct ssh_agent_struct* ssh_agent;
 
   99typedef struct ssh_buffer_struct* ssh_buffer;
 
  100typedef struct ssh_channel_struct* ssh_channel;
 
  101typedef struct ssh_message_struct* ssh_message;
 
  102typedef struct ssh_pcap_file_struct* ssh_pcap_file;
 
  103typedef struct ssh_key_struct* ssh_key;
 
  104typedef struct ssh_scp_struct* ssh_scp;
 
  105typedef struct ssh_session_struct* ssh_session;
 
  106typedef struct ssh_string_struct* ssh_string;
 
  107typedef struct ssh_event_struct* ssh_event;
 
  108typedef struct ssh_connector_struct * ssh_connector;
 
  109typedef void* ssh_gssapi_creds;
 
  114typedef SOCKET socket_t;
 
  122#define SSH_INVALID_SOCKET ((socket_t) -1) 
  125enum ssh_kex_types_e {
 
  153#define SSH_AUTH_METHOD_UNKNOWN     0x0000u 
  154#define SSH_AUTH_METHOD_NONE        0x0001u 
  155#define SSH_AUTH_METHOD_PASSWORD    0x0002u 
  156#define SSH_AUTH_METHOD_PUBLICKEY   0x0004u 
  157#define SSH_AUTH_METHOD_HOSTBASED   0x0008u 
  158#define SSH_AUTH_METHOD_INTERACTIVE 0x0010u 
  159#define SSH_AUTH_METHOD_GSSAPI_MIC  0x0020u 
  164    SSH_REQUEST_CHANNEL_OPEN,
 
  170enum ssh_channel_type_e {
 
  171    SSH_CHANNEL_UNKNOWN=0,
 
  173    SSH_CHANNEL_DIRECT_TCPIP,
 
  174    SSH_CHANNEL_FORWARDED_TCPIP,
 
  176    SSH_CHANNEL_AUTH_AGENT
 
  179enum ssh_channel_requests_e {
 
  180    SSH_CHANNEL_REQUEST_UNKNOWN=0,
 
  181    SSH_CHANNEL_REQUEST_PTY,
 
  182    SSH_CHANNEL_REQUEST_EXEC,
 
  183    SSH_CHANNEL_REQUEST_SHELL,
 
  184    SSH_CHANNEL_REQUEST_ENV,
 
  185    SSH_CHANNEL_REQUEST_SUBSYSTEM,
 
  186    SSH_CHANNEL_REQUEST_WINDOW_CHANGE,
 
  187    SSH_CHANNEL_REQUEST_X11
 
  190enum ssh_global_requests_e {
 
  191    SSH_GLOBAL_REQUEST_UNKNOWN=0,
 
  192    SSH_GLOBAL_REQUEST_TCPIP_FORWARD,
 
  193    SSH_GLOBAL_REQUEST_CANCEL_TCPIP_FORWARD,
 
  194    SSH_GLOBAL_REQUEST_KEEPALIVE,
 
  195    SSH_GLOBAL_REQUEST_NO_MORE_SESSIONS
 
  198enum ssh_publickey_state_e {
 
  199    SSH_PUBLICKEY_STATE_ERROR=-1,
 
  200    SSH_PUBLICKEY_STATE_NONE=0,
 
  201    SSH_PUBLICKEY_STATE_VALID=1,
 
  202    SSH_PUBLICKEY_STATE_WRONG=2
 
  207#define SSH_CLOSED 0x01 
  209#define SSH_READ_PENDING 0x02 
  211#define SSH_CLOSED_ERROR 0x04 
  213#define SSH_WRITE_PENDING 0x08 
  215enum ssh_server_known_e {
 
  217    SSH_SERVER_NOT_KNOWN=0,
 
  219    SSH_SERVER_KNOWN_CHANGED,
 
  220    SSH_SERVER_FOUND_OTHER,
 
  221    SSH_SERVER_FILE_NOT_FOUND
 
  224enum ssh_known_hosts_e {
 
  228    SSH_KNOWN_HOSTS_ERROR = -2,
 
  234    SSH_KNOWN_HOSTS_NOT_FOUND = -1,
 
  240    SSH_KNOWN_HOSTS_UNKNOWN = 0,
 
  252    SSH_KNOWN_HOSTS_CHANGED,
 
  258    SSH_KNOWN_HOSTS_OTHER,
 
  261#ifndef MD5_DIGEST_LEN 
  262    #define MD5_DIGEST_LEN 16 
  266enum ssh_error_types_e {
 
  275  SSH_KEYTYPE_UNKNOWN=0,
 
  281  SSH_KEYTYPE_DSS_CERT01, 
 
  282  SSH_KEYTYPE_RSA_CERT01,
 
  283  SSH_KEYTYPE_ECDSA_P256,
 
  284  SSH_KEYTYPE_ECDSA_P384,
 
  285  SSH_KEYTYPE_ECDSA_P521,
 
  286  SSH_KEYTYPE_ECDSA_P256_CERT01,
 
  287  SSH_KEYTYPE_ECDSA_P384_CERT01,
 
  288  SSH_KEYTYPE_ECDSA_P521_CERT01,
 
  289  SSH_KEYTYPE_ED25519_CERT01,
 
  290  SSH_KEYTYPE_SK_ECDSA,
 
  291  SSH_KEYTYPE_SK_ECDSA_CERT01,
 
  292  SSH_KEYTYPE_SK_ED25519,
 
  293  SSH_KEYTYPE_SK_ED25519_CERT01,
 
  297  SSH_KEY_CMP_PUBLIC = 0,
 
  298  SSH_KEY_CMP_PRIVATE = 1,
 
  299  SSH_KEY_CMP_CERTIFICATE = 2,
 
  302#define SSH_ADDRSTRLEN 46 
  304struct ssh_knownhosts_entry {
 
  342#define SSH_LOG_RARE SSH_LOG_WARNING 
  352#define SSH_LOG_NONE 0 
  354#define SSH_LOG_WARN 1 
  356#define SSH_LOG_INFO 2 
  358#define SSH_LOG_DEBUG 3 
  360#define SSH_LOG_TRACE 4 
  364enum ssh_control_master_options_e {
 
  365  SSH_CONTROL_MASTER_NO,
 
  366  SSH_CONTROL_MASTER_AUTO,
 
  367  SSH_CONTROL_MASTER_YES,
 
  368  SSH_CONTROL_MASTER_ASK,
 
  369  SSH_CONTROL_MASTER_AUTOASK
 
  375    SSH_OPTIONS_PORT_STR,
 
  379    SSH_OPTIONS_IDENTITY,
 
  380    SSH_OPTIONS_ADD_IDENTITY,
 
  381    SSH_OPTIONS_KNOWNHOSTS,
 
  383    SSH_OPTIONS_TIMEOUT_USEC,
 
  386    SSH_OPTIONS_LOG_VERBOSITY,
 
  387    SSH_OPTIONS_LOG_VERBOSITY_STR,
 
  388    SSH_OPTIONS_CIPHERS_C_S,
 
  389    SSH_OPTIONS_CIPHERS_S_C,
 
  390    SSH_OPTIONS_COMPRESSION_C_S,
 
  391    SSH_OPTIONS_COMPRESSION_S_C,
 
  392    SSH_OPTIONS_PROXYCOMMAND,
 
  393    SSH_OPTIONS_BINDADDR,
 
  394    SSH_OPTIONS_STRICTHOSTKEYCHECK,
 
  395    SSH_OPTIONS_COMPRESSION,
 
  396    SSH_OPTIONS_COMPRESSION_LEVEL,
 
  397    SSH_OPTIONS_KEY_EXCHANGE,
 
  398    SSH_OPTIONS_HOSTKEYS,
 
  399    SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
 
  400    SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
 
  401    SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
 
  402    SSH_OPTIONS_HMAC_C_S,
 
  403    SSH_OPTIONS_HMAC_S_C,
 
  404    SSH_OPTIONS_PASSWORD_AUTH,
 
  405    SSH_OPTIONS_PUBKEY_AUTH,
 
  406    SSH_OPTIONS_KBDINT_AUTH,
 
  407    SSH_OPTIONS_GSSAPI_AUTH,
 
  408    SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
 
  410    SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
 
  411    SSH_OPTIONS_PROCESS_CONFIG,
 
  412    SSH_OPTIONS_REKEY_DATA,
 
  413    SSH_OPTIONS_REKEY_TIME,
 
  414    SSH_OPTIONS_RSA_MIN_SIZE,
 
  415    SSH_OPTIONS_IDENTITY_AGENT,
 
  416    SSH_OPTIONS_IDENTITIES_ONLY,
 
  417    SSH_OPTIONS_CONTROL_MASTER,
 
  418    SSH_OPTIONS_CONTROL_PATH,
 
  419    SSH_OPTIONS_CERTIFICATE,
 
  420    SSH_OPTIONS_PROXYJUMP,
 
  421    SSH_OPTIONS_PROXYJUMP_CB_LIST_APPEND,
 
  429  SSH_SCP_RECURSIVE=0x10
 
  432enum ssh_scp_request_types {
 
  434  SSH_SCP_REQUEST_NEWDIR=1,
 
  436  SSH_SCP_REQUEST_NEWFILE,
 
  440  SSH_SCP_REQUEST_ENDDIR,
 
  442  SSH_SCP_REQUEST_WARNING
 
  445enum ssh_connector_flags_e {
 
  447    SSH_CONNECTOR_STDOUT = 1,
 
  448    SSH_CONNECTOR_STDINOUT = 1,
 
  450    SSH_CONNECTOR_STDERR = 2,
 
  452    SSH_CONNECTOR_BOTH = 3
 
  459#define SSH_CHANNEL_FREE(x)      \ 
  462            ssh_channel_free(x); \ 
  468                                          uint32_t *pexit_code,
 
  479    int remoteport, 
const char *sourcehost, 
int localport);
 
  481    const char *sourcehost, 
int localport);
 
  486LIBSSH_API 
int ssh_channel_read(ssh_channel channel, 
void *dest, uint32_t count, 
int is_stderr);
 
  487LIBSSH_API 
int ssh_channel_read_timeout(ssh_channel channel, 
void *dest, uint32_t count, 
int is_stderr, 
int timeout_ms);
 
  493LIBSSH_API 
int ssh_channel_request_pty_size(ssh_channel channel, 
const char *term,
 
  496    int cols, 
int rows, 
const unsigned char* modes, 
size_t modes_len);
 
  503    const char *cookie, 
int screen_number);
 
  508                                        ssh_counter counter);
 
  509LIBSSH_API 
int ssh_channel_write(ssh_channel channel, 
const void *data, uint32_t len);
 
  519LIBSSH_API ssh_connector ssh_connector_new(ssh_session session);
 
  520LIBSSH_API 
void ssh_connector_free(ssh_connector connector);
 
  521LIBSSH_API 
int ssh_connector_set_in_channel(ssh_connector connector,
 
  523                                            enum ssh_connector_flags_e flags);
 
  524LIBSSH_API 
int ssh_connector_set_out_channel(ssh_connector connector,
 
  526                                             enum ssh_connector_flags_e flags);
 
  527LIBSSH_API 
void ssh_connector_set_in_fd(ssh_connector connector, socket_t fd);
 
  528LIBSSH_API 
void ssh_connector_set_out_fd(ssh_connector connector, socket_t fd);
 
  538                                                   int *destination_port,
 
  540                                                   int *originator_port);
 
  543                                                  int *destination_port);
 
  552LIBSSH_API 
void ssh_free(ssh_session session);
 
  556LIBSSH_API socket_t 
ssh_get_fd(ssh_session session);
 
  557LIBSSH_API 
char *
ssh_get_hexa(
const unsigned char *what, 
size_t len);
 
  564enum ssh_publickey_hash_type {
 
  565    SSH_PUBLICKEY_HASH_SHA1,
 
  566    SSH_PUBLICKEY_HASH_MD5,
 
  567    SSH_PUBLICKEY_HASH_SHA256
 
  570                                      enum ssh_publickey_hash_type type,
 
  571                                      unsigned char **hash,
 
  575SSH_DEPRECATED LIBSSH_API 
int ssh_get_pubkey_hash(ssh_session session, 
unsigned char **hash);
 
  576SSH_DEPRECATED LIBSSH_API ssh_channel ssh_forward_accept(ssh_session session, 
int timeout_ms);
 
  577SSH_DEPRECATED LIBSSH_API 
int ssh_forward_cancel(ssh_session session, 
const char *address, 
int port);
 
  578SSH_DEPRECATED LIBSSH_API 
int ssh_forward_listen(ssh_session session, 
const char *address, 
int port, 
int *bound_port);
 
  579SSH_DEPRECATED LIBSSH_API 
int ssh_get_publickey(ssh_session session, ssh_key *key);
 
  583SSH_DEPRECATED LIBSSH_API 
void ssh_print_hexa(
const char *descr, 
const unsigned char *what, 
size_t len);
 
  584SSH_DEPRECATED LIBSSH_API 
int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, 
struct 
  590SSH_DEPRECATED LIBSSH_API 
void ssh_scp_free(ssh_scp scp);
 
  593SSH_DEPRECATED LIBSSH_API ssh_scp 
ssh_scp_new(ssh_session session, 
int mode, 
const char *location);
 
  596SSH_DEPRECATED LIBSSH_API 
int ssh_scp_push_file(ssh_scp scp, 
const char *filename, 
size_t size, 
int perms);
 
  597SSH_DEPRECATED LIBSSH_API 
int ssh_scp_push_file64(ssh_scp scp, 
const char *filename, uint64_t size, 
int perms);
 
  598SSH_DEPRECATED LIBSSH_API 
int ssh_scp_read(ssh_scp scp, 
void *buffer, 
size_t size);
 
  604SSH_DEPRECATED LIBSSH_API 
int ssh_scp_write(ssh_scp scp, 
const void *buffer, 
size_t len);
 
  617#define SSH_KNOWNHOSTS_ENTRY_FREE(e) do { \ 
  619    ssh_knownhosts_entry_free(e); \ 
  626                                          struct ssh_knownhosts_entry **entry);
 
  630                                                    char **pentry_string);
 
  634        struct ssh_knownhosts_entry **pentry);
 
  642LIBSSH_API 
void ssh_vlog(
int verbosity,
 
  643                         const char *function,
 
  645                         va_list *va) PRINTF_ATTRIBUTE(3, 0);
 
  646LIBSSH_API 
void _ssh_log(
int verbosity,
 
  647                         const char *function,
 
  648                         const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
 
  651SSH_DEPRECATED LIBSSH_API 
void ssh_log(ssh_session session,
 
  653                                       const 
char *format, ...) PRINTF_ATTRIBUTE(3, 4);
 
  655LIBSSH_API ssh_channel ssh_message_channel_request_open_reply_accept(ssh_message msg);
 
  656LIBSSH_API 
int ssh_message_channel_request_open_reply_accept_channel(ssh_message msg, ssh_channel chan);
 
  657LIBSSH_API 
int ssh_message_channel_request_reply_success(ssh_message msg);
 
  658#define SSH_MESSAGE_FREE(x) \ 
  659    do { if ((x) != NULL) { ssh_message_free(x); (x) = NULL; } } while(0) 
  664LIBSSH_API 
int ssh_mkdir (
const char *pathname, mode_t mode);
 
  665LIBSSH_API ssh_session 
ssh_new(
void);
 
  670LIBSSH_API 
int ssh_options_set(ssh_session session, 
enum ssh_options_e type,
 
  672LIBSSH_API 
int ssh_options_get(ssh_session session, 
enum ssh_options_e type,
 
  675LIBSSH_API 
int ssh_pcap_file_close(ssh_pcap_file pcap);
 
  676LIBSSH_API 
void ssh_pcap_file_free(ssh_pcap_file pcap);
 
  677LIBSSH_API ssh_pcap_file ssh_pcap_file_new(
void);
 
  678LIBSSH_API 
int ssh_pcap_file_open(ssh_pcap_file pcap, 
const char *filename);
 
  700    int echo, 
int verify, 
void *userdata);
 
  704enum ssh_file_format_e {
 
  705    SSH_FILE_FORMAT_DEFAULT = 0,
 
  706    SSH_FILE_FORMAT_OPENSSH,
 
  711#define SSH_KEY_FREE(x) \ 
  712    do { if ((x) != NULL) { ssh_key_free(x); x = NULL; } } while(0) 
  714LIBSSH_API 
enum ssh_keytypes_e 
ssh_key_type(
const ssh_key key);
 
  721                           enum ssh_keycmp_e what);
 
  727                                             const char *passphrase,
 
  732                                             const char *passphrase,
 
  738                                     const char *passphrase,
 
  742                                     enum ssh_file_format_e format);
 
  744                                           const char *passphrase,
 
  749                                           const char *passphrase,
 
  752                                           const char *filename);
 
  755                                   const char *passphrase,
 
  758                                   const char *filename,
 
  759                                   enum ssh_file_format_e format);
 
  765                                            enum ssh_keytypes_e type,
 
  771                                          enum ssh_keytypes_e type,
 
  781                                          const char *filename);
 
  788LIBSSH_API 
void ssh_print_hash(
enum ssh_publickey_hash_type type, 
unsigned char *hash, 
size_t len);
 
  790LIBSSH_API 
int ssh_send_debug (ssh_session session, 
const char *message, 
int always_display);
 
  791LIBSSH_API 
void ssh_gssapi_set_creds(ssh_session session, 
const ssh_gssapi_creds creds);
 
  792LIBSSH_API 
int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd,
 
  793    fd_set *readfds, 
struct timeval *timeout);
 
  794LIBSSH_API 
int ssh_service_request(ssh_session session, 
const char *service);
 
  799                                 ssh_counter rcounter);
 
  804LIBSSH_API 
int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcapfile);
 
  810                                          const char *username,
 
  811                                          const ssh_key pubkey);
 
  813                                      const char *username,
 
  814                                      const ssh_key privkey);
 
  816                                  const char *username);
 
  820                                           const char *username,
 
  821                                           const char *passphrase);
 
  823                                     const char *username,
 
  824                                     const char *password);
 
  826LIBSSH_API 
int ssh_userauth_kbdint(ssh_session session, 
const char *user, 
const char *submethods);
 
  836LIBSSH_API 
const char *
ssh_version(
int req_version);
 
  838LIBSSH_API 
void ssh_string_burn(ssh_string str);
 
  839LIBSSH_API ssh_string ssh_string_copy(ssh_string str);
 
  840LIBSSH_API 
void *ssh_string_data(ssh_string str);
 
  841LIBSSH_API 
int ssh_string_fill(ssh_string str, 
const void *data, 
size_t len);
 
  842#define SSH_STRING_FREE(x) \ 
  843    do { if ((x) != NULL) { ssh_string_free(x); x = NULL; } } while(0) 
  844LIBSSH_API 
void ssh_string_free(ssh_string str);
 
  846LIBSSH_API 
size_t ssh_string_len(ssh_string str);
 
  848LIBSSH_API 
const char *ssh_string_get_char(ssh_string str);
 
  849LIBSSH_API 
char *ssh_string_to_char(ssh_string str);
 
  850#define SSH_STRING_FREE_CHAR(x) \ 
  851    do { if ((x) != NULL) { ssh_string_free_char(x); x = NULL; } } while(0) 
  854LIBSSH_API 
int ssh_getpass(
const char *prompt, 
char *buf, 
size_t len, 
int echo,
 
  858typedef int (*ssh_event_callback)(socket_t fd, 
int revents, 
void *userdata);
 
  862                                    ssh_event_callback cb, 
void *userdata);
 
  879LIBSSH_API 
void ssh_buffer_free(ssh_buffer buffer);
 
  880#define SSH_BUFFER_FREE(x) \ 
  881    do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0) 
  882LIBSSH_API 
int ssh_buffer_reinit(ssh_buffer buffer);
 
  883LIBSSH_API 
int ssh_buffer_add_data(ssh_buffer buffer, 
const void *data, uint32_t len);
 
  884LIBSSH_API uint32_t ssh_buffer_get_data(ssh_buffer buffer, 
void *data, uint32_t requestedlen);
 
  885LIBSSH_API 
void *ssh_buffer_get(ssh_buffer buffer);
 
  886LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
 
  889#ifndef LIBSSH_LEGACY_0_4 
  890#include "libssh/legacy.h" 
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:2174
LIBSSH_API int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method.
Definition auth.c:2301
LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server.
Definition auth.c:379
LIBSSH_API int ssh_userauth_kbdint_getnanswers(ssh_session session)
Get the number of answers the client has given.
Definition auth.c:2202
int(* ssh_auth_callback)(const char *prompt, char *buf, size_t len, int echo, int verify, void *userdata)
SSH authentication callback for password and publickey auth.
Definition libssh.h:699
LIBSSH_API const char * ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i)
Get the answer to a question from a message block.
Definition auth.c:2220
LIBSSH_API int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition auth.c:1616
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:1272
LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method.
Definition auth.c:409
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:493
LIBSSH_API int ssh_set_agent_channel(ssh_session session, ssh_channel channel)
sets the SSH agent channel. The SSH agent channel will be used to authenticate this client using an a...
Definition agent.c:171
LIBSSH_API const char * ssh_userauth_kbdint_getname(ssh_session session)
Get the "name" of the message block.
Definition auth.c:2113
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:2046
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:2253
LIBSSH_API int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent.
Definition auth.c:908
LIBSSH_API int ssh_userauth_publickey_auto_get_current_identity(ssh_session session, char **value)
Get the identity that is currently being processed by ssh_userauth_publickey_auto()
Definition auth.c:1209
LIBSSH_API int ssh_set_agent_socket(ssh_session session, socket_t fd)
sets the SSH agent socket. The SSH agent will be used to authenticate this client using the given soc...
Definition agent.c:190
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:623
LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given.
Definition auth.c:2090
LIBSSH_API const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block.
Definition auth.c:2137
LIBSSH_API ssh_buffer ssh_buffer_new(void)
Create a new SSH buffer.
Definition buffer.c:120
LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp").
Definition channels.c:2120
LIBSSH_API int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition channels.c:1360
SSH_DEPRECATED 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:3589
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition channels.c:3252
LIBSSH_API int ssh_channel_get_exit_state(ssh_channel channel, uint32_t *pexit_code, char **pexit_signal, int *pcore_dumped)
Get the exit state of the channel (error code from the executed instruction or signal).
Definition channels.c:3416
LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode.
Definition channels.c:1760
LIBSSH_API int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition channels.c:1421
LIBSSH_API int ssh_channel_request_pty_size_modes(ssh_channel channel, const char *term, int cols, int rows, const unsigned char *modes, size_t modes_len)
Request a pty with a specific type and size.
Definition channels.c:1956
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:3080
LIBSSH_API int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition channels.c:2037
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:2666
LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel)
Request sftp subsystem on the channel.
Definition channels.c:2170
SSH_DEPRECATED 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 some information about incoming connection.
Definition channels.c:2623
LIBSSH_API ssh_channel ssh_channel_open_forward_port(ssh_session session, int timeout_ms, int *destination_port, char **originator, int *originator_port)
Accept an incoming TCP/IP forwarding channel and get information about incoming connection.
Definition channels.c:2647
LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition channels.c:2348
LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition channels.c:2789
LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel.
Definition channels.c:1691
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:1080
LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel.
Definition channels.c:3365
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:2557
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition channels.c:2718
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:3751
LIBSSH_API int ssh_channel_open_forward_unix(ssh_channel channel, const char *remotepath, const char *sourcehost, int localport)
Open a TCP/IP - UNIX domain socket forwarding channel.
Definition channels.c:1192
SSH_DEPRECATED 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:3484
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:2855
LIBSSH_API int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition channels.c:1705
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:3191
LIBSSH_API void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter.
Definition channels.c:3730
LIBSSH_API int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not.
Definition channels.c:1722
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:2364
LIBSSH_API int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition channels.c:1737
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:3306
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:3051
LIBSSH_API void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition channels.c:1258
LIBSSH_API ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel.
Definition channels.c:90
LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel)
Get the remote window size.
Definition channels.c:1673
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:2224
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port)
Open a X11 channel.
Definition channels.c:3846
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:1119
LIBSSH_API int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition channels.c:2097
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:2900
LIBSSH_API int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition channels.c:1052
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:2057
LIBSSH_API int ssh_get_error_code(void *error)
Retrieve the error code from the last error.
Definition error.c:148
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_set_log_userdata(void *data)
Set the userdata for the logging function.
Definition log.c:255
LIBSSH_API void * ssh_get_log_userdata(void)
Get the userdata of the logging function.
Definition log.c:239
LIBSSH_API int ssh_set_log_level(int level)
Set the log level of the library.
Definition log.c:195
LIBSSH_API int ssh_get_log_level(void)
Get the log level of the library.
Definition log.c:210
@ SSH_LOG_WARNING
Definition libssh.h:330
@ SSH_LOG_PACKET
Definition libssh.h:336
@ SSH_LOG_PROTOCOL
Definition libssh.h:333
@ SSH_LOG_FUNCTIONS
Definition libssh.h:339
@ SSH_LOG_NOLOG
Definition libssh.h:327
LIBSSH_API int ssh_message_type(ssh_message msg)
Get the type of the message.
Definition messages.c:591
LIBSSH_API int ssh_message_subtype(ssh_message msg)
Get the subtype of the message.
Definition messages.c:606
LIBSSH_API ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session.
Definition messages.c:558
LIBSSH_API void ssh_message_free(ssh_message msg)
Free a SSH message.
Definition messages.c:630
LIBSSH_API char * ssh_dirname(const char *path)
Parse directory component.
Definition misc.c:918
SSH_DEPRECATED LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len)
Definition misc.c:484
LIBSSH_API int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname.
Definition misc.c:1029
LIBSSH_API int ssh_get_random(void *where, int len, int strong)
Get random bytes.
Definition getrandom_crypto.c:47
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 misc.c:455
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 const char * ssh_version(int req_version)
Check if libssh is the required version or get the version string.
Definition misc.c:706
LIBSSH_API char * ssh_basename(const char *path)
basename - parse filename component.
Definition misc.c:977
LIBSSH_API void ssh_key_free(ssh_key key)
deallocate a SSH key
Definition pki.c:179
LIBSSH_API int ssh_key_is_private(const ssh_key k)
Check if the key is a private key.
Definition pki.c:640
LIBSSH_API int ssh_pki_export_privkey_base64_format(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, char **b64_key, enum ssh_file_format_e format)
Convert a private key to a base64 encoded key in given format.
Definition pki.c:863
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:91
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 private key from a file or a PKCS #11 device.
Definition pki.c:976
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:2208
LIBSSH_API int ssh_pki_export_privkey_base64(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, char **b64_key)
Convert a private key to a pem base64 encoded key, or OpenSSH format for keytype ssh-ed25519.
Definition pki.c:939
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:1166
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:545
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:659
LIBSSH_API int ssh_pki_export_pubkey_file(const ssh_key key, const char *filename)
Export public key to file.
Definition pki.c:2246
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:2105
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 formatted key from a memory c-string
Definition pki.c:796
LIBSSH_API const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string.
Definition pki.c:261
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:2313
LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formatted certificate from a memory c-string.
Definition pki.c:1943
LIBSSH_API int ssh_pki_import_cert_file(const char *filename, ssh_key *pkey)
Import a certificate from the given filename.
Definition pki.c:1984
LIBSSH_API int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key.
Definition pki.c:624
LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key
Definition pki.c:198
LIBSSH_API ssh_key ssh_key_new(void)
creates a new empty SSH key
Definition pki.c:109
LIBSSH_API int ssh_pki_import_pubkey_base64(const char *b64_key, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formatted public key from a memory c-string.
Definition pki.c:1635
LIBSSH_API int ssh_pki_export_privkey_file_format(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, const char *filename, enum ssh_file_format_e format)
Export a private key to a file in format specified in the argument.
Definition pki.c:1081
LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a key pair.
Definition pki.c:2016
LIBSSH_API ssh_key ssh_key_dup(const ssh_key key)
duplicates the key
Definition pki.c:126
LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename, ssh_key *pkey)
Import a public key from a file or a PKCS #11 device.
Definition pki.c:1798
LIBSSH_API void ssh_event_free(ssh_event event)
Free an event context.
Definition poll.c:1145
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:802
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:861
LIBSSH_API int ssh_event_add_session(ssh_event event, ssh_session session)
remove the poll handle from session and assign them to an event, when used in blocking mode.
Definition poll.c:931
LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session)
Remove a session object from an event context.
Definition poll.c:1076
LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout)
Poll all the sockets and sessions associated through an event object.
Definition poll.c:1009
LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector)
Remove a connector from an event context.
Definition poll.c:1131
LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector)
Add a connector to the SSH event loop.
Definition poll.c:984
LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd)
Remove a socket fd from an event context.
Definition poll.c:1029
SSH_DEPRECATED LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size)
Read from a remote scp file.
Definition scp.c:1011
SSH_DEPRECATED LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len)
Write into a remote scp file.
Definition scp.c:670
SSH_DEPRECATED LIBSSH_API int ssh_scp_close(ssh_scp scp)
Close the scp channel.
Definition scp.c:249
SSH_DEPRECATED LIBSSH_API int ssh_scp_init(ssh_scp scp)
Initialize the scp channel.
Definition scp.c:125
SSH_DEPRECATED LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp)
Leave a directory.
Definition scp.c:423
SSH_DEPRECATED 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:1101
SSH_DEPRECATED LIBSSH_API const char * ssh_scp_request_get_warning(ssh_scp scp)
Get the warning string from a scp handle.
Definition scp.c:1185
SSH_DEPRECATED 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:472
SSH_DEPRECATED 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:575
SSH_DEPRECATED 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:1084
SSH_DEPRECATED 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:1120
SSH_DEPRECATED LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location)
Create a new scp session.
Definition scp.c:65
SSH_DEPRECATED 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:332
SSH_DEPRECATED LIBSSH_API int ssh_scp_pull_request(ssh_scp scp)
Wait for a scp request (file, directory).
Definition scp.c:809
SSH_DEPRECATED LIBSSH_API void ssh_scp_free(ssh_scp scp)
Free a scp context.
Definition scp.c:296
SSH_DEPRECATED 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:923
SSH_DEPRECATED 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:969
SSH_DEPRECATED 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:1135
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:482
LIBSSH_API int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition client.c:528
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:685
LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash.
Definition session.c:1148
LIBSSH_API const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition session.c:900
LIBSSH_API int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh.
Definition session.c:576
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:659
LIBSSH_API void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server).
Definition client.c:786
LIBSSH_API const char * ssh_get_serverbanner(ssh_session session)
get the server banner
Definition session.c:411
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:498
LIBSSH_API char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition client.c:684
LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode.
Definition session.c:561
LIBSSH_API char * ssh_get_fingerprint_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len)
Get a hash as a human-readable hex- or base64-string.
Definition dh.c:737
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:672
LIBSSH_API int ssh_is_connected(ssh_session session)
Check if we are connected.
Definition session.c:627
LIBSSH_API const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm.
Definition session.c:425
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:920
LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session.
Definition session.c:1165
SSH_DEPRECATED LIBSSH_API char * ssh_dump_knownhost(ssh_session session)
This function is deprecated.
Definition known_hosts.c:446
LIBSSH_API int ssh_send_debug(ssh_session session, const char *message, int always_display)
Send a debug message.
Definition session.c:997
LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer.
Definition session.c:602
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:466
LIBSSH_API const char * ssh_copyright(void)
Copyright information.
Definition client.c:896
LIBSSH_API const char * ssh_get_clientbanner(ssh_session session)
get the client banner
Definition session.c:396
SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session)
This function is deprecated.
Definition known_hosts.c:304
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 session.c:1220
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:645
LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition options.c:1815
SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key)
Definition session.c:1187
LIBSSH_API int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition session.c:925
LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters.
Definition session.c:1053
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:334
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 currently connected session.
Definition knownhosts.c:1163
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:809
LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv)
Parse command line arguments.
Definition options.c:1635
LIBSSH_API int ssh_session_update_known_hosts(ssh_session session)
Adds the currently connected server to the user known_hosts file.
Definition knownhosts.c:993
LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry)
Free an allocated ssh_knownhosts_entry.
Definition knownhosts.c:155
LIBSSH_API int ssh_request_no_more_sessions(ssh_session session)
Most SSH connections will only ever request a single session, but an attacker may abuse a running ssh...
Definition client.c:732
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....
Definition options.c:1413
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:635
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:1511
LIBSSH_API ssh_session ssh_new(void)
Create a new ssh session.
Definition session.c:60
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:513
LIBSSH_API int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored.
Definition session.c:962
LIBSSH_API int ssh_session_set_disconnect_message(ssh_session session, const char *message)
Add disconnect message when ssh_session is disconnected To add a disconnect message to give peer a be...
Definition client.c:750
LIBSSH_API int ssh_get_status(ssh_session session)
Get session status.
Definition session.c:842
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:711
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:1288
LIBSSH_API void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition session.c:544
LIBSSH_API void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition session.c:209
LIBSSH_API int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop.
Definition session.c:880
LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure.
Definition options.c:68
SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session)
This function is deprecated.
Definition known_hosts.c:514
SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash)
Definition session.c:1064
LIBSSH_API socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition session.c:645
LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session)
Check if the set hostname and port match an entry in known_hosts.
Definition knownhosts.c:805
LIBSSH_API ssh_string ssh_string_from_char(const char *what)
Create a ssh string using a C string.
Definition string.c:108
LIBSSH_API ssh_string ssh_string_new(size_t size)
Create a new SSH String object.
Definition string.c:56
LIBSSH_API void ssh_string_free_char(char *s)
Deallocate a char string object.
Definition string.c:209
LIBSSH_API int ssh_init(void)
Initialize global cryptographic data structures.
Definition init.c:156
LIBSSH_API int ssh_finalize(void)
Finalize and clean up all libssh and cryptographic data structures.
Definition init.c:241