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")))
57 typedef unsigned int uint32_t;
58 typedef unsigned short uint16_t;
59 typedef unsigned char uint8_t;
60 typedef unsigned long long uint64_t;
65 #include <sys/types.h>
71 #include <sys/select.h>
75#define SSH_STRINGIFY(s) SSH_TOSTRING(s)
76#define SSH_TOSTRING(s) #s
80#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
82#define PRINTF_ATTRIBUTE(a,b)
85#if !defined(SSH_SUPPRESS_DEPRECATED) && defined(__GNUC__)
86#define SSH_DEPRECATED __attribute__ ((deprecated))
107typedef struct ssh_pcap_file_struct* ssh_pcap_file;
114typedef void* ssh_gssapi_creds;
119typedef SOCKET socket_t;
127#define SSH_INVALID_SOCKET ((socket_t) -1)
130enum ssh_kex_types_e {
158#define SSH_AUTH_METHOD_UNKNOWN 0x0000u
159#define SSH_AUTH_METHOD_NONE 0x0001u
160#define SSH_AUTH_METHOD_PASSWORD 0x0002u
161#define SSH_AUTH_METHOD_PUBLICKEY 0x0004u
162#define SSH_AUTH_METHOD_HOSTBASED 0x0008u
163#define SSH_AUTH_METHOD_INTERACTIVE 0x0010u
164#define SSH_AUTH_METHOD_GSSAPI_MIC 0x0020u
169 SSH_REQUEST_CHANNEL_OPEN,
175enum ssh_channel_type_e {
176 SSH_CHANNEL_UNKNOWN=0,
178 SSH_CHANNEL_DIRECT_TCPIP,
179 SSH_CHANNEL_FORWARDED_TCPIP,
181 SSH_CHANNEL_AUTH_AGENT
184enum ssh_channel_requests_e {
185 SSH_CHANNEL_REQUEST_UNKNOWN=0,
186 SSH_CHANNEL_REQUEST_PTY,
187 SSH_CHANNEL_REQUEST_EXEC,
188 SSH_CHANNEL_REQUEST_SHELL,
189 SSH_CHANNEL_REQUEST_ENV,
190 SSH_CHANNEL_REQUEST_SUBSYSTEM,
191 SSH_CHANNEL_REQUEST_WINDOW_CHANGE,
192 SSH_CHANNEL_REQUEST_X11
195enum ssh_global_requests_e {
196 SSH_GLOBAL_REQUEST_UNKNOWN=0,
197 SSH_GLOBAL_REQUEST_TCPIP_FORWARD,
198 SSH_GLOBAL_REQUEST_CANCEL_TCPIP_FORWARD,
199 SSH_GLOBAL_REQUEST_KEEPALIVE
202enum ssh_publickey_state_e {
203 SSH_PUBLICKEY_STATE_ERROR=-1,
204 SSH_PUBLICKEY_STATE_NONE=0,
205 SSH_PUBLICKEY_STATE_VALID=1,
206 SSH_PUBLICKEY_STATE_WRONG=2
211#define SSH_CLOSED 0x01
213#define SSH_READ_PENDING 0x02
215#define SSH_CLOSED_ERROR 0x04
217#define SSH_WRITE_PENDING 0x08
219enum ssh_server_known_e {
221 SSH_SERVER_NOT_KNOWN=0,
223 SSH_SERVER_KNOWN_CHANGED,
224 SSH_SERVER_FOUND_OTHER,
225 SSH_SERVER_FILE_NOT_FOUND
228enum ssh_known_hosts_e {
232 SSH_KNOWN_HOSTS_ERROR = -2,
238 SSH_KNOWN_HOSTS_NOT_FOUND = -1,
244 SSH_KNOWN_HOSTS_UNKNOWN = 0,
256 SSH_KNOWN_HOSTS_CHANGED,
262 SSH_KNOWN_HOSTS_OTHER,
265#ifndef MD5_DIGEST_LEN
266 #define MD5_DIGEST_LEN 16
270enum ssh_error_types_e {
279 SSH_KEYTYPE_UNKNOWN=0,
285 SSH_KEYTYPE_DSS_CERT01,
286 SSH_KEYTYPE_RSA_CERT01,
287 SSH_KEYTYPE_ECDSA_P256,
288 SSH_KEYTYPE_ECDSA_P384,
289 SSH_KEYTYPE_ECDSA_P521,
290 SSH_KEYTYPE_ECDSA_P256_CERT01,
291 SSH_KEYTYPE_ECDSA_P384_CERT01,
292 SSH_KEYTYPE_ECDSA_P521_CERT01,
293 SSH_KEYTYPE_ED25519_CERT01,
294 SSH_KEYTYPE_SK_ECDSA,
295 SSH_KEYTYPE_SK_ECDSA_CERT01,
296 SSH_KEYTYPE_SK_ED25519,
297 SSH_KEYTYPE_SK_ED25519_CERT01,
301 SSH_KEY_CMP_PUBLIC = 0,
305#define SSH_ADDRSTRLEN 46
345#define SSH_LOG_RARE SSH_LOG_WARNING
355#define SSH_LOG_NONE 0
357#define SSH_LOG_WARN 1
359#define SSH_LOG_INFO 2
361#define SSH_LOG_DEBUG 3
363#define SSH_LOG_TRACE 4
370 SSH_OPTIONS_PORT_STR,
374 SSH_OPTIONS_IDENTITY,
375 SSH_OPTIONS_ADD_IDENTITY,
376 SSH_OPTIONS_KNOWNHOSTS,
378 SSH_OPTIONS_TIMEOUT_USEC,
381 SSH_OPTIONS_LOG_VERBOSITY,
382 SSH_OPTIONS_LOG_VERBOSITY_STR,
383 SSH_OPTIONS_CIPHERS_C_S,
384 SSH_OPTIONS_CIPHERS_S_C,
385 SSH_OPTIONS_COMPRESSION_C_S,
386 SSH_OPTIONS_COMPRESSION_S_C,
387 SSH_OPTIONS_PROXYCOMMAND,
388 SSH_OPTIONS_BINDADDR,
389 SSH_OPTIONS_STRICTHOSTKEYCHECK,
390 SSH_OPTIONS_COMPRESSION,
391 SSH_OPTIONS_COMPRESSION_LEVEL,
392 SSH_OPTIONS_KEY_EXCHANGE,
393 SSH_OPTIONS_HOSTKEYS,
394 SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
395 SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
396 SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
397 SSH_OPTIONS_HMAC_C_S,
398 SSH_OPTIONS_HMAC_S_C,
399 SSH_OPTIONS_PASSWORD_AUTH,
400 SSH_OPTIONS_PUBKEY_AUTH,
401 SSH_OPTIONS_KBDINT_AUTH,
402 SSH_OPTIONS_GSSAPI_AUTH,
403 SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
405 SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
406 SSH_OPTIONS_PROCESS_CONFIG,
407 SSH_OPTIONS_REKEY_DATA,
408 SSH_OPTIONS_REKEY_TIME,
409 SSH_OPTIONS_RSA_MIN_SIZE,
410 SSH_OPTIONS_IDENTITY_AGENT,
418 SSH_SCP_RECURSIVE=0x10
421enum ssh_scp_request_types {
423 SSH_SCP_REQUEST_NEWDIR=1,
425 SSH_SCP_REQUEST_NEWFILE,
429 SSH_SCP_REQUEST_ENDDIR,
431 SSH_SCP_REQUEST_WARNING
434enum ssh_connector_flags_e {
436 SSH_CONNECTOR_STDOUT = 1,
437 SSH_CONNECTOR_STDINOUT = 1,
439 SSH_CONNECTOR_STDERR = 2,
441 SSH_CONNECTOR_BOTH = 3
457 int remoteport,
const char *sourcehost,
int localport);
459 const char *sourcehost,
int localport);
479 const char *cookie,
int screen_number);
497LIBSSH_API
int ssh_connector_set_in_channel(
ssh_connector connector,
499 enum ssh_connector_flags_e flags);
500LIBSSH_API
int ssh_connector_set_out_channel(
ssh_connector connector,
502 enum ssh_connector_flags_e flags);
503LIBSSH_API
void ssh_connector_set_in_fd(
ssh_connector connector, socket_t fd);
504LIBSSH_API
void ssh_connector_set_out_fd(
ssh_connector connector, socket_t fd);
514 int *destination_port,
516 int *originator_port);
519 int *destination_port);
533LIBSSH_API
char *
ssh_get_hexa(
const unsigned char *what,
size_t len);
539enum ssh_publickey_hash_type {
540 SSH_PUBLICKEY_HASH_SHA1,
541 SSH_PUBLICKEY_HASH_MD5,
542 SSH_PUBLICKEY_HASH_SHA256
545 enum ssh_publickey_hash_type type,
546 unsigned char **hash,
552SSH_DEPRECATED LIBSSH_API
int ssh_forward_cancel(
ssh_session session,
const char *address,
int port);
553SSH_DEPRECATED LIBSSH_API
int ssh_forward_listen(
ssh_session session,
const char *address,
int port,
int *bound_port);
558SSH_DEPRECATED LIBSSH_API
void ssh_print_hexa(
const char *descr,
const unsigned char *what,
size_t len);
592#define SSH_KNOWNHOSTS_ENTRY_FREE(e) do { \
594 ssh_knownhosts_entry_free(e); \
605 char **pentry_string);
617LIBSSH_API
void ssh_vlog(
int verbosity,
618 const char *function,
620 va_list *va) PRINTF_ATTRIBUTE(3, 0);
621LIBSSH_API
void _ssh_log(
int verbosity,
622 const char *function,
623 const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
626SSH_DEPRECATED LIBSSH_API
void ssh_log(
ssh_session session,
628 const
char *format, ...) PRINTF_ATTRIBUTE(3, 4);
632LIBSSH_API
int ssh_message_channel_request_reply_success(
ssh_message msg);
633#define SSH_MESSAGE_FREE(x) \
634 do { if ((x) != NULL) { ssh_message_free(x); (x) = NULL; } } while(0)
639LIBSSH_API
int ssh_mkdir (
const char *pathname, mode_t mode);
650LIBSSH_API
int ssh_pcap_file_close(ssh_pcap_file pcap);
651LIBSSH_API
void ssh_pcap_file_free(ssh_pcap_file pcap);
652LIBSSH_API ssh_pcap_file ssh_pcap_file_new(
void);
653LIBSSH_API
int ssh_pcap_file_open(ssh_pcap_file pcap,
const char *filename);
675 int echo,
int verify,
void *userdata);
680#define SSH_KEY_FREE(x) \
681 do { if ((x) != NULL) { ssh_key_free(x); x = NULL; } } while(0)
690 enum ssh_keycmp_e what);
696 const char *passphrase,
701 const char *passphrase,
706 const char *passphrase,
711 const char *passphrase,
714 const char *filename);
720 enum ssh_keytypes_e type,
726 enum ssh_keytypes_e type,
736 const char *filename);
743LIBSSH_API
void ssh_print_hash(
enum ssh_publickey_hash_type type,
unsigned char *hash,
size_t len);
746LIBSSH_API
void ssh_gssapi_set_creds(
ssh_session session,
const ssh_gssapi_creds creds);
748 fd_set *readfds,
struct timeval *timeout);
759LIBSSH_API
int ssh_set_pcap_file(
ssh_session session, ssh_pcap_file pcapfile);
765 const char *username,
768 const char *username,
772 const char *username);
777 const char *username,
778 const char *passphrase);
780 const char *username,
781 const char *password);
793LIBSSH_API
const char *
ssh_version(
int req_version);
795LIBSSH_API
void ssh_string_burn(
ssh_string str);
797LIBSSH_API
void *ssh_string_data(
ssh_string str);
798LIBSSH_API
int ssh_string_fill(
ssh_string str,
const void *data,
size_t len);
799#define SSH_STRING_FREE(x) \
800 do { if ((x) != NULL) { ssh_string_free(x); x = NULL; } } while(0)
801LIBSSH_API
void ssh_string_free(
ssh_string str);
803LIBSSH_API
size_t ssh_string_len(
ssh_string str);
805LIBSSH_API
const char *ssh_string_get_char(
ssh_string str);
806LIBSSH_API
char *ssh_string_to_char(
ssh_string str);
807#define SSH_STRING_FREE_CHAR(x) \
808 do { if ((x) != NULL) { ssh_string_free_char(x); x = NULL; } } while(0)
811LIBSSH_API
int ssh_getpass(
const char *prompt,
char *buf,
size_t len,
int echo,
815typedef int (*ssh_event_callback)(socket_t fd,
int revents,
void *userdata);
819 ssh_event_callback cb,
void *userdata);
836LIBSSH_API
void ssh_buffer_free(
ssh_buffer buffer);
837#define SSH_BUFFER_FREE(x) \
838 do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
839LIBSSH_API
int ssh_buffer_reinit(
ssh_buffer buffer);
840LIBSSH_API
int ssh_buffer_add_data(
ssh_buffer buffer,
const void *data, uint32_t len);
841LIBSSH_API uint32_t ssh_buffer_get_data(
ssh_buffer buffer,
void *data, uint32_t requestedlen);
842LIBSSH_API
void *ssh_buffer_get(
ssh_buffer buffer);
843LIBSSH_API uint32_t ssh_buffer_get_len(
ssh_buffer buffer);
846#ifndef LIBSSH_LEGACY_0_4
847#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:1888
LIBSSH_API int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method.
Definition auth.c:2014
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:1916
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:674
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:1933
LIBSSH_API int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition auth.c:1332
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:1087
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:1827
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:1760
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:1966
LIBSSH_API int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent.
Definition auth.c:904
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:1028
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:622
LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given.
Definition auth.c:1804
LIBSSH_API const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block.
Definition auth.c:1851
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:2010
LIBSSH_API int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition channels.c:1281
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:3422
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition channels.c:3160
LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode.
Definition channels.c:1683
LIBSSH_API int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition channels.c:1342
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:2976
LIBSSH_API int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition channels.c:1927
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:2556
LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel)
Request sftp subsystem on the channel.
Definition channels.c:2060
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:2513
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:2537
LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition channels.c:2238
LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition channels.c:2679
LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel.
Definition channels.c:1614
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:1002
LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel.
Definition channels.c:3274
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:2447
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition channels.c:2608
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:3584
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:1114
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:3314
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:2745
LIBSSH_API int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition channels.c:1628
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:3101
LIBSSH_API void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter.
Definition channels.c:3563
LIBSSH_API int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not.
Definition channels.c:1645
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:2254
LIBSSH_API int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition channels.c:1660
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:3214
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:1863
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:2946
LIBSSH_API void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition channels.c:1180
LIBSSH_API ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel.
Definition channels.c:87
LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel)
Get the remote window size.
Definition channels.c:1596
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:2114
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port)
Open a X11 channel.
Definition channels.c:3679
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:1041
LIBSSH_API int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition channels.c:1987
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:2790
LIBSSH_API int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition channels.c:974
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:1947
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:249
LIBSSH_API void * ssh_get_log_userdata(void)
Get the userdata of the logging function.
Definition log.c:233
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:333
@ SSH_LOG_PACKET
Definition libssh.h:339
@ SSH_LOG_PROTOCOL
Definition libssh.h:336
@ SSH_LOG_FUNCTIONS
Definition libssh.h:342
@ SSH_LOG_NOLOG
Definition libssh.h:330
LIBSSH_API int ssh_message_type(ssh_message msg)
Get the type of the message.
Definition messages.c:549
LIBSSH_API int ssh_message_subtype(ssh_message msg)
Get the subtype of the message.
Definition messages.c:564
LIBSSH_API ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session.
Definition messages.c:516
LIBSSH_API void ssh_message_free(ssh_message msg)
Free a SSH message.
Definition messages.c:588
LIBSSH_API char * ssh_dirname(const char *path)
Parse directory component.
Definition misc.c:908
SSH_DEPRECATED LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len)
Definition misc.c:476
LIBSSH_API int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname.
Definition misc.c:1019
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:447
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:698
LIBSSH_API char * ssh_basename(const char *path)
basename - parse filename component.
Definition misc.c:967
LIBSSH_API void ssh_key_free(ssh_key key)
deallocate a SSH key
Definition pki.c:200
LIBSSH_API int ssh_key_is_private(const ssh_key k)
Check if the key is a private key.
Definition pki.c:674
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:112
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:941
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:2135
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:881
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:1043
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:571
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:693
LIBSSH_API int ssh_pki_export_pubkey_file(const ssh_key key, const char *filename)
Export public key to file.
Definition pki.c:2173
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:2067
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:818
LIBSSH_API const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string.
Definition pki.c:282
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:2240
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:1909
LIBSSH_API int ssh_pki_import_cert_file(const char *filename, ssh_key *pkey)
Import a certificate from the given filename.
Definition pki.c:1950
LIBSSH_API int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key.
Definition pki.c:658
LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key
Definition pki.c:219
LIBSSH_API ssh_key ssh_key_new(void)
creates a new empty SSH key
Definition pki.c:130
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:1623
LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a key pair.
Definition pki.c:1972
LIBSSH_API ssh_key ssh_key_dup(const ssh_key key)
duplicates the key
Definition pki.c:147
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:1786
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:997
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:664
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:1083
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:1167
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:1066
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:1102
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:795
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:909
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:955
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:1117
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:440
LIBSSH_API int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition client.c:524
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:627
LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash.
Definition session.c:1083
LIBSSH_API const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition session.c:838
LIBSSH_API int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh.
Definition session.c:518
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:601
LIBSSH_API void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server).
Definition client.c:749
LIBSSH_API const char * ssh_get_serverbanner(ssh_session session)
get the server banner
Definition session.c:369
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:456
LIBSSH_API char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition client.c:668
LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode.
Definition session.c:503
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:614
LIBSSH_API int ssh_is_connected(ssh_session session)
Check if we are connected.
Definition session.c:569
LIBSSH_API const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm.
Definition session.c:383
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:927
LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session.
Definition session.c:1100
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:935
LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer.
Definition session.c:544
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:424
LIBSSH_API const char * ssh_copyright(void)
Copyright information.
Definition client.c:852
LIBSSH_API const char * ssh_get_clientbanner(ssh_session session)
get the client banner
Definition session.c:354
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:1155
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:499
LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition options.c:1446
SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key)
Definition session.c:1122
LIBSSH_API int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition session.c:863
LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters.
Definition session.c:991
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:323
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:1170
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:1255
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:1000
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_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:1113
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:642
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:1171
LIBSSH_API ssh_session ssh_new(void)
Create a new ssh session.
Definition session.c:59
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:471
LIBSSH_API int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored.
Definition session.c:900
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:712
LIBSSH_API int ssh_get_status(ssh_session session)
Get session status.
Definition session.c:780
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:695
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:1295
LIBSSH_API void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition session.c:486
LIBSSH_API void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition session.c:195
LIBSSH_API int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop.
Definition session.c:818
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:1002
LIBSSH_API socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition session.c:587
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:812
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
Definition connector.c:54