25#ifndef _SSH_CALLBACK_H
26#define _SSH_CALLBACK_H
28#include <libssh/libssh.h>
49typedef void (*ssh_callback_int) (
int code,
void *user);
59typedef size_t (*ssh_callback_data) (
const void *data,
size_t len,
void *user);
61typedef void (*ssh_callback_int_int) (
int code,
int errno_code,
void *user);
64typedef int (*ssh_channel_callback_int) (
ssh_channel channel,
int code,
void *user);
65typedef int (*ssh_channel_callback_data) (
ssh_channel channel,
int code,
void *data,
size_t len,
void *user);
75 const char *message,
void *userdata);
125 const char * originator_address,
int originator_port,
void *userdata);
232 char signature_state,
void *userdata);
282typedef int (*ssh_gssapi_accept_sec_ctx_callback) (
ssh_session session,
296typedef int (*ssh_gssapi_verify_mic_callback) (
ssh_session session,
297 ssh_string mic,
void *mic_buffer,
size_t mic_buffer_size,
void *userdata);
347 ssh_gssapi_verify_mic_callback gssapi_verify_mic_function;
406#define SSH_SOCKET_FLOW_WRITEWILLBLOCK 1
407#define SSH_SOCKET_FLOW_WRITEWONTBLOCK 2
409#define SSH_SOCKET_EXCEPTION_EOF 1
410#define SSH_SOCKET_EXCEPTION_ERROR 2
412#define SSH_SOCKET_CONNECTED_OK 1
413#define SSH_SOCKET_CONNECTED_ERROR 2
414#define SSH_SOCKET_CONNECTED_TIMEOUT 3
423#define ssh_callbacks_init(p) do {\
424 (p)->size=sizeof(*(p)); \
436#define ssh_callbacks_exists(p,c) (\
437 (p != NULL) && ( (char *)&((p)-> c) < (char *)(p) + (p)->size ) && \
457#define ssh_callbacks_execute_list(list, cbtype, c, ...) \
459 struct ssh_iterator *i = ssh_list_get_iterator(list); \
462 cb = ssh_iterator_value(cbtype, i); \
463 if (ssh_callbacks_exists(cb, c)) \
464 cb-> c (__VA_ARGS__, cb->userdata); \
489#define ssh_callbacks_iterate(_cb_list, _cb_type, _cb_name) \
491 struct ssh_iterator *_cb_i = ssh_list_get_iterator(_cb_list); \
493 for (; _cb_i != NULL; _cb_i = _cb_i->next) { \
494 _cb = ssh_iterator_value(_cb_type, _cb_i); \
495 if (ssh_callbacks_exists(_cb, _cb_name))
497#define ssh_callbacks_iterate_exec(_cb_name, ...) \
498 _cb->_cb_name(__VA_ARGS__, _cb->userdata)
500#define ssh_callbacks_iterate_end() \
517#define SSH_PACKET_USED 1
520#define SSH_PACKET_NOT_USED 2
530#define SSH_PACKET_CALLBACK(name) \
531 int name (ssh_session session, uint8_t type, ssh_buffer packet, void *user)
668 int width,
int height,
669 int pxwidth,
int pwheight,
702 int single_connection,
703 const char *auth_protocol,
704 const char *auth_cookie,
705 uint32_t screen_number,
720 int width,
int height,
721 int pxwidth,
int pwheight,
750 const char *env_name,
751 const char *env_value,
763 const char *subsystem,
924typedef int (*ssh_thread_callback) (
void **lock);
926typedef unsigned long (*ssh_thread_id_callback) (void);
929 ssh_thread_callback mutex_init;
930 ssh_thread_callback mutex_destroy;
931 ssh_thread_callback mutex_lock;
932 ssh_thread_callback mutex_unlock;
933 ssh_thread_id_callback thread_id;
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
int(* ssh_channel_pty_request_callback)(ssh_session session, ssh_channel channel, const char *term, int width, int height, int pxwidth, int pwheight, void *userdata)
SSH channel PTY request from a client.
Definition: callbacks.h:665
LIBSSH_API int ssh_set_callbacks(ssh_session session, ssh_callbacks cb)
Set the session callback functions.
Definition: callbacks.c:48
LIBSSH_API int ssh_add_channel_callbacks(ssh_channel channel, ssh_channel_callbacks cb)
Add channel callback functions.
Definition: callbacks.c:109
int(* ssh_channel_pty_window_change_callback)(ssh_session session, ssh_channel channel, int width, int height, int pxwidth, int pwheight, void *userdata)
SSH channel PTY windows change (terminal size) from a client.
Definition: callbacks.h:718
int(* ssh_channel_exec_request_callback)(ssh_session session, ssh_channel channel, const char *command, void *userdata)
SSH channel Exec request from a client.
Definition: callbacks.h:732
void(* ssh_channel_x11_req_callback)(ssh_session session, ssh_channel channel, int single_connection, const char *auth_protocol, const char *auth_cookie, uint32_t screen_number, void *userdata)
SSH X11 request from the client. This request is sent by a client when X11 forwarding is requested(an...
Definition: callbacks.h:700
int(* ssh_channel_shell_request_callback)(ssh_session session, ssh_channel channel, void *userdata)
SSH channel Shell request from a client.
Definition: callbacks.h:679
int(* ssh_channel_data_callback)(ssh_session session, ssh_channel channel, void *data, uint32_t len, int is_stderr, void *userdata)
SSH channel data callback. Called when data is available on a channel.
Definition: callbacks.h:585
void(* ssh_channel_eof_callback)(ssh_session session, ssh_channel channel, void *userdata)
SSH channel eof callback. Called when a channel receives EOF.
Definition: callbacks.h:598
void(* ssh_channel_close_callback)(ssh_session session, ssh_channel channel, void *userdata)
SSH channel close callback. Called when a channel is closed by remote peer.
Definition: callbacks.h:608
void(* ssh_channel_signal_callback)(ssh_session session, ssh_channel channel, const char *signal, void *userdata)
SSH channel signal callback. Called when a channel has received a signal.
Definition: callbacks.h:619
int(* ssh_auth_pubkey_callback)(ssh_session session, const char *user, struct ssh_key_struct *pubkey, char signature_state, void *userdata)
SSH authentication callback.
Definition: callbacks.h:231
int(* ssh_packet_callback)(ssh_session session, uint8_t type, ssh_buffer packet, void *user)
Prototype for a packet callback, to be called when a new packet arrives.
Definition: callbacks.h:513
void(* ssh_channel_exit_status_callback)(ssh_session session, ssh_channel channel, int exit_status, void *userdata)
SSH channel exit status callback. Called when a channel has received an exit status.
Definition: callbacks.h:630
ssh_channel(* ssh_channel_open_request_x11_callback)(ssh_session session, const char *originator_address, int originator_port, void *userdata)
Handles an SSH new channel open X11 request. This happens when the server sends back an X11 connectio...
Definition: callbacks.h:124
int(* ssh_auth_none_callback)(ssh_session session, const char *user, void *userdata)
SSH authentication callback. Tries to authenticates user with the "none" method which is anonymous or...
Definition: callbacks.h:201
void(* ssh_log_callback)(ssh_session session, int priority, const char *message, void *userdata)
SSH log callback. All logging messages will go through this callback.
Definition: callbacks.h:74
int(* ssh_service_request_callback)(ssh_session session, const char *service, void *userdata)
Handles an SSH service request.
Definition: callbacks.h:244
LIBSSH_API int ssh_set_server_callbacks(ssh_session session, ssh_server_callbacks cb)
Set the session server callback functions.
Definition: callbacks.c:133
ssh_channel(* ssh_channel_open_request_auth_agent_callback)(ssh_session session, void *userdata)
Handles an SSH new channel open "auth-agent" request. This happens when the server sends back an "aut...
Definition: callbacks.h:136
int(* ssh_channel_write_wontblock_callback)(ssh_session session, ssh_channel channel, uint32_t bytes, void *userdata)
SSH channel write will not block (flow control).
Definition: callbacks.h:778
int(* ssh_auth_gssapi_mic_callback)(ssh_session session, const char *user, const char *principal, void *userdata)
SSH authentication callback. Tries to authenticates user with the "gssapi-with-mic" method.
Definition: callbacks.h:215
void(* ssh_logging_callback)(int priority, const char *function, const char *buffer, void *userdata)
SSH log callback.
Definition: callbacks.h:90
void(* ssh_status_callback)(ssh_session session, float status, void *userdata)
SSH Connection status callback.
Definition: callbacks.h:102
ssh_channel(* ssh_channel_open_request_session_callback)(ssh_session session, void *userdata)
Handles an SSH new channel open session request.
Definition: callbacks.h:254
void(* ssh_channel_exit_signal_callback)(ssh_session session, ssh_channel channel, const char *signal, int core, const char *errmsg, const char *lang, void *userdata)
SSH channel exit signal callback. Called when a channel has received an exit signal.
Definition: callbacks.h:645
LIBSSH_API int ssh_set_channel_callbacks(ssh_channel channel, ssh_channel_callbacks cb)
Set the channel callback functions.
Definition: callbacks.c:104
int(* ssh_auth_password_callback)(ssh_session session, const char *user, const char *password, void *userdata)
SSH authentication callback.
Definition: callbacks.h:188
LIBSSH_API int ssh_remove_channel_callbacks(ssh_channel channel, ssh_channel_callbacks cb)
Remove a channel callback.
Definition: callbacks.c:114
int(* ssh_channel_env_request_callback)(ssh_session session, ssh_channel channel, const char *env_name, const char *env_value, void *userdata)
SSH channel environment request from a client.
Definition: callbacks.h:748
void(* ssh_global_request_callback)(ssh_session session, ssh_message message, void *userdata)
SSH global request callback. All global request will go through this callback.
Definition: callbacks.h:112
void(* ssh_channel_auth_agent_req_callback)(ssh_session session, ssh_channel channel, void *userdata)
SSH auth-agent-request from the client. This request is sent by a client when agent forwarding is ava...
Definition: callbacks.h:689
int(* ssh_channel_subsystem_request_callback)(ssh_session session, ssh_channel channel, const char *subsystem, void *userdata)
SSH channel subsystem request from a client.
Definition: callbacks.h:761
LIBSSH_API ssh_logging_callback ssh_get_log_callback(void)
Get the pointer to the logging callback function.
Definition: log.c:224
LIBSSH_API int ssh_set_log_callback(ssh_logging_callback cb)
Set the logging callback function.
Definition: log.c:214
LIBSSH_API int ssh_threads_set_callbacks(struct ssh_threads_callbacks_struct *cb)
Set the thread callbacks structure.
Definition: threads.c:71
Definition: callbacks.h:142
ssh_channel_open_request_auth_agent_callback channel_open_request_auth_agent_function
Definition: callbacks.h:171
ssh_log_callback log_function
Definition: callbacks.h:156
ssh_auth_callback auth_function
Definition: callbacks.h:152
ssh_channel_open_request_x11_callback channel_open_request_x11_function
Definition: callbacks.h:168
void * userdata
Definition: callbacks.h:148
size_t size
Definition: callbacks.h:144
void(* connect_status_function)(void *userdata, float status)
Definition: callbacks.h:161
ssh_global_request_callback global_request_function
Definition: callbacks.h:165
Definition: callbacks.h:783
ssh_channel_data_callback channel_data_function
Definition: callbacks.h:793
ssh_channel_write_wontblock_callback channel_write_wontblock_function
Definition: callbacks.h:849
ssh_channel_x11_req_callback channel_x11_req_function
Definition: callbacks.h:829
ssh_channel_exit_status_callback channel_exit_status_function
Definition: callbacks.h:809
ssh_channel_shell_request_callback channel_shell_request_function
Definition: callbacks.h:821
ssh_channel_env_request_callback channel_env_request_function
Definition: callbacks.h:841
ssh_channel_subsystem_request_callback channel_subsystem_request_function
Definition: callbacks.h:845
ssh_channel_eof_callback channel_eof_function
Definition: callbacks.h:797
size_t size
Definition: callbacks.h:785
ssh_channel_pty_window_change_callback channel_pty_window_change_function
Definition: callbacks.h:833
ssh_channel_auth_agent_req_callback channel_auth_agent_req_function
Definition: callbacks.h:825
ssh_channel_exit_signal_callback channel_exit_signal_function
Definition: callbacks.h:813
ssh_channel_pty_request_callback channel_pty_request_function
Definition: callbacks.h:817
void * userdata
Definition: callbacks.h:789
ssh_channel_signal_callback channel_signal_function
Definition: callbacks.h:805
ssh_channel_close_callback channel_close_function
Definition: callbacks.h:801
ssh_channel_exec_request_callback channel_exec_request_function
Definition: callbacks.h:837
Definition: channels.h:62
Definition: messages.h:85
Definition: callbacks.h:533
uint8_t start
Definition: callbacks.h:535
ssh_packet_callback * callbacks
Definition: callbacks.h:539
void * user
Definition: callbacks.h:543
uint8_t n_callbacks
Definition: callbacks.h:537
Definition: callbacks.h:304
ssh_gssapi_accept_sec_ctx_callback gssapi_accept_sec_ctx_function
Definition: callbacks.h:344
ssh_service_request_callback service_request_function
Definition: callbacks.h:334
size_t size
Definition: callbacks.h:306
ssh_auth_none_callback auth_none_function
Definition: callbacks.h:319
ssh_auth_gssapi_mic_callback auth_gssapi_mic_function
Definition: callbacks.h:324
ssh_channel_open_request_session_callback channel_open_request_session_function
Definition: callbacks.h:338
ssh_auth_password_callback auth_password_function
Definition: callbacks.h:314
ssh_auth_pubkey_callback auth_pubkey_function
Definition: callbacks.h:329
void * userdata
Definition: callbacks.h:310
ssh_gssapi_select_oid_callback gssapi_select_oid_function
Definition: callbacks.h:341
Definition: session.h:110
Definition: callbacks.h:381
void * userdata
Definition: callbacks.h:385
ssh_callback_data data
Definition: callbacks.h:390
ssh_callback_int_int connected
Definition: callbacks.h:402
ssh_callback_int controlflow
Definition: callbacks.h:394
ssh_callback_int_int exception
Definition: callbacks.h:398
Definition: callbacks.h:927