libssh
0.10.90
The SSH library
|
Data Structures | |
struct | ssh_bind_callbacks_struct |
These are the callbacks exported by the ssh_bind structure. More... | |
Typedefs | |
typedef void(* | ssh_bind_incoming_connection_callback) (ssh_bind sshbind, void *userdata) |
Incoming connection callback. This callback is called when a ssh_bind has a new incoming connection. | |
Functions | |
LIBSSH_API ssh_bind | ssh_bind_new (void) |
Creates a new SSH server bind. | |
LIBSSH_API int | ssh_bind_options_set (ssh_bind sshbind, enum ssh_bind_options_e type, const void *value) |
Set options for an SSH server bind. | |
LIBSSH_API int | ssh_bind_options_parse_config (ssh_bind sshbind, const char *filename) |
Parse a ssh bind options configuration file. | |
LIBSSH_API int | ssh_bind_listen (ssh_bind ssh_bind_o) |
Start listening to the socket. | |
LIBSSH_API int | ssh_bind_set_callbacks (ssh_bind sshbind, ssh_bind_callbacks callbacks, void *userdata) |
Set the callback for this bind. | |
LIBSSH_API void | ssh_bind_set_blocking (ssh_bind ssh_bind_o, int blocking) |
Set the session to blocking/nonblocking mode. | |
LIBSSH_API socket_t | ssh_bind_get_fd (ssh_bind ssh_bind_o) |
Recover the file descriptor from the session. | |
LIBSSH_API void | ssh_bind_set_fd (ssh_bind ssh_bind_o, socket_t fd) |
Set the file descriptor for a session. | |
LIBSSH_API void | ssh_bind_fd_toaccept (ssh_bind ssh_bind_o) |
Allow the file descriptor to accept new sessions. | |
LIBSSH_API int | ssh_bind_accept (ssh_bind ssh_bind_o, ssh_session session) |
Accept an incoming ssh connection and initialize the session. | |
LIBSSH_API int | ssh_bind_accept_fd (ssh_bind ssh_bind_o, ssh_session session, socket_t fd) |
Accept an incoming ssh connection on the given file descriptor and initialize the session. | |
LIBSSH_API ssh_gssapi_creds | ssh_gssapi_get_creds (ssh_session session) |
returns the client credentials of the connected client. If the client has given a forwardable token, the SSH server will retrieve it. | |
LIBSSH_API int | ssh_handle_key_exchange (ssh_session session) |
Handles the key exchange and set up encryption. | |
LIBSSH_API int | ssh_server_init_kex (ssh_session session) |
Initialize the set of key exchange, hostkey, ciphers, MACs, and compression algorithms for the given ssh_session. | |
LIBSSH_API void | ssh_bind_free (ssh_bind ssh_bind_o) |
Free a ssh servers bind. | |
LIBSSH_API void | ssh_set_auth_methods (ssh_session session, int auth_methods) |
Set the acceptable authentication methods to be sent to the client. | |
LIBSSH_API int | ssh_send_issue_banner (ssh_session session, const ssh_string banner) |
Send the server's issue-banner to client. | |
LIBSSH_API int | ssh_message_reply_default (ssh_message msg) |
Reply with a standard reject message. | |
LIBSSH_API const char * | ssh_message_auth_user (ssh_message msg) |
Get the name of the authenticated user. | |
SSH_DEPRECATED LIBSSH_API const char * | ssh_message_auth_password (ssh_message msg) |
Get the password of the authenticated user. | |
SSH_DEPRECATED LIBSSH_API ssh_key | ssh_message_auth_pubkey (ssh_message msg) |
Get the publickey of the authenticated user. | |
LIBSSH_API int | ssh_message_auth_kbdint_is_response (ssh_message msg) |
Check if the message is a keyboard-interactive response. | |
SSH_DEPRECATED LIBSSH_API enum ssh_publickey_state_e | ssh_message_auth_publickey_state (ssh_message msg) |
LIBSSH_API int | ssh_message_auth_reply_success (ssh_message msg, int partial) |
LIBSSH_API int | ssh_message_auth_reply_pk_ok (ssh_message msg, ssh_string algo, ssh_string pubkey) |
Answer SSH2_MSG_USERAUTH_PK_OK to a pubkey authentication request. | |
LIBSSH_API int | ssh_message_auth_reply_pk_ok_simple (ssh_message msg) |
Answer SSH2_MSG_USERAUTH_PK_OK to a pubkey authentication request. | |
LIBSSH_API int | ssh_message_auth_set_methods (ssh_message msg, int methods) |
Sets the supported authentication methods to a message. | |
LIBSSH_API int | ssh_message_auth_interactive_request (ssh_message msg, const char *name, const char *instruction, unsigned int num_prompts, const char **prompts, char *echo) |
LIBSSH_API int | ssh_message_service_reply_success (ssh_message msg) |
Sends SERVICE_ACCEPT to the client. | |
LIBSSH_API const char * | ssh_message_service_service (ssh_message msg) |
Gets the service name from the service request message. | |
LIBSSH_API int | ssh_message_global_request_reply_success (ssh_message msg, uint16_t bound_port) |
Send a global request success message. | |
LIBSSH_API void | ssh_set_message_callback (ssh_session session, int(*ssh_bind_message_callback)(ssh_session session, ssh_message msg, void *data), void *data) |
defines the ssh_message callback | |
LIBSSH_API int | ssh_execute_message_callbacks (ssh_session session) |
LIBSSH_API const char * | ssh_message_channel_request_open_originator (ssh_message msg) |
LIBSSH_API int | ssh_message_channel_request_open_originator_port (ssh_message msg) |
LIBSSH_API const char * | ssh_message_channel_request_open_destination (ssh_message msg) |
LIBSSH_API int | ssh_message_channel_request_open_destination_port (ssh_message msg) |
LIBSSH_API ssh_channel | ssh_message_channel_request_channel (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API const char * | ssh_message_channel_request_pty_term (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API int | ssh_message_channel_request_pty_width (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API int | ssh_message_channel_request_pty_height (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API int | ssh_message_channel_request_pty_pxwidth (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API int | ssh_message_channel_request_pty_pxheight (ssh_message msg) |
LIBSSH_API const char * | ssh_message_channel_request_env_name (ssh_message msg) |
LIBSSH_API const char * | ssh_message_channel_request_env_value (ssh_message msg) |
LIBSSH_API const char * | ssh_message_channel_request_command (ssh_message msg) |
LIBSSH_API const char * | ssh_message_channel_request_subsystem (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API int | ssh_message_channel_request_x11_single_connection (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API const char * | ssh_message_channel_request_x11_auth_protocol (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API const char * | ssh_message_channel_request_x11_auth_cookie (ssh_message msg) |
SSH_DEPRECATED LIBSSH_API int | ssh_message_channel_request_x11_screen_number (ssh_message msg) |
LIBSSH_API const char * | ssh_message_global_request_address (ssh_message msg) |
LIBSSH_API int | ssh_message_global_request_port (ssh_message msg) |
LIBSSH_API int | ssh_channel_open_reverse_forward (ssh_channel channel, const char *remotehost, int remoteport, const char *sourcehost, int localport) |
Open a TCP/IP reverse forwarding channel. | |
LIBSSH_API int | ssh_channel_open_x11 (ssh_channel channel, const char *orig_addr, int orig_port) |
Open a X11 channel. | |
LIBSSH_API int | ssh_channel_request_send_exit_status (ssh_channel channel, int exit_status) |
Send the exit status to the remote process. | |
LIBSSH_API int | ssh_channel_request_send_exit_signal (ssh_channel channel, const char *signum, int core, const char *errmsg, const char *lang) |
Send an exit signal to remote process (RFC 4254, section 6.10). | |
LIBSSH_API int | ssh_send_keepalive (ssh_session session) |
Sends a keepalive message to the session. | |
SSH_DEPRECATED LIBSSH_API int | ssh_accept (ssh_session session) |
SSH_DEPRECATED LIBSSH_API int | channel_write_stderr (ssh_channel channel, const void *data, uint32_t len) |
ssh_poll_handle | ssh_bind_get_poll (ssh_bind sshbind) |
int | server_set_kex (ssh_session session) |
SSH_PACKET_CALLBACK (ssh_packet_kexdh_init) | |
int | ssh_get_key_params (ssh_session session, ssh_key *privkey, enum ssh_digest_e *digest) |
int | ssh_auth_reply_default (ssh_session session, int partial) |
ssh_public_key | ssh_message_auth_publickey (ssh_message msg) |
int | ssh_auth_reply_success (ssh_session session, int partial) |
Sends SSH2_MSG_USERAUTH_SUCCESS or SSH2_MSG_USERAUTH_FAILURE message depending on the success of the authentication method. | |
typedef void(* ssh_bind_incoming_connection_callback) (ssh_bind sshbind, void *userdata) |
Incoming connection callback. This callback is called when a ssh_bind has a new incoming connection.
sshbind | Current sshbind session handler |
userdata | Userdata to be passed to the callback function. |
int ssh_auth_reply_success | ( | ssh_session | session, |
int | partial ) |
Sends SSH2_MSG_USERAUTH_SUCCESS or SSH2_MSG_USERAUTH_FAILURE message depending on the success of the authentication method.
session | The session to reply to |
partial | Denotes if the authentication process was partially completed (unsuccessful) |
int ssh_bind_accept | ( | ssh_bind | ssh_bind_o, |
ssh_session | session ) |
Accept an incoming ssh connection and initialize the session.
ssh_bind_o | The ssh server bind to accept a connection. |
session | A preallocated ssh session |
int ssh_bind_accept_fd | ( | ssh_bind | ssh_bind_o, |
ssh_session | session, | ||
socket_t | fd ) |
Accept an incoming ssh connection on the given file descriptor and initialize the session.
ssh_bind_o | The ssh server bind to accept a connection. |
session | A preallocated ssh session |
fd | A file descriptor of an already established TCP inbound connection |
void ssh_bind_fd_toaccept | ( | ssh_bind | ssh_bind_o | ) |
Allow the file descriptor to accept new sessions.
ssh_bind_o | The ssh server bind to use. |
void ssh_bind_free | ( | ssh_bind | ssh_bind_o | ) |
Free a ssh servers bind.
Note that this will also free options that have been set on the bind, including keys set with SSH_BIND_OPTIONS_IMPORT_KEY.
ssh_bind_o | The ssh server bind to free. |
socket_t ssh_bind_get_fd | ( | ssh_bind | ssh_bind_o | ) |
Recover the file descriptor from the session.
ssh_bind_o | The ssh server bind to get the fd from. |
int ssh_bind_listen | ( | ssh_bind | ssh_bind_o | ) |
Start listening to the socket.
ssh_bind_o | The ssh server bind to use. |
ssh_bind ssh_bind_new | ( | void | ) |
Creates a new SSH server bind.
int ssh_bind_options_parse_config | ( | ssh_bind | sshbind, |
const char * | filename ) |
Parse a ssh bind options configuration file.
This parses the options file and set them to the ssh_bind handle provided. If an option was previously set, it is overridden. If the global configuration hasn't been processed yet, it is processed prior to the provided file.
sshbind | SSH bind handle |
filename | The options file to use; if NULL only the global configuration is parsed and applied (if it hasn't been processed before). |
int ssh_bind_options_set | ( | ssh_bind | sshbind, |
enum ssh_bind_options_e | type, | ||
const void * | value ) |
Set options for an SSH server bind.
sshbind | The ssh server bind to configure. |
type | The option type to set. This should be one of the following: |
value | The value to set. This is a generic pointer and the datatype which should be used is described at the corresponding value of type above. |
void ssh_bind_set_blocking | ( | ssh_bind | ssh_bind_o, |
int | blocking ) |
Set the session to blocking/nonblocking mode.
ssh_bind_o | The ssh server bind to use. |
blocking | Zero for nonblocking mode. |
int ssh_bind_set_callbacks | ( | ssh_bind | sshbind, |
ssh_bind_callbacks | callbacks, | ||
void * | userdata ) |
Set the callback for this bind.
[in] | sshbind | The bind to set the callback on. |
[in] | callbacks | An already set up ssh_bind_callbacks instance. |
[in] | userdata | A pointer to private data to pass to the callbacks. |
void ssh_bind_set_fd | ( | ssh_bind | ssh_bind_o, |
socket_t | fd ) |
Set the file descriptor for a session.
ssh_bind_o | The ssh server bind to set the fd. |
fd | The file descriptssh_bind B |
LIBSSH_API int ssh_channel_open_reverse_forward | ( | ssh_channel | channel, |
const char * | remotehost, | ||
int | remoteport, | ||
const char * | sourcehost, | ||
int | localport ) |
Open a TCP/IP reverse forwarding channel.
[in] | channel | An allocated channel. |
[in] | remotehost | The remote host to connected (host name or IP). |
[in] | remoteport | The remote port. |
[in] | sourcehost | The source host (your local computer). It's optional and for logging purpose. |
[in] | localport | The source port (your local computer). It's optional and for logging purpose. |
LIBSSH_API int ssh_channel_open_x11 | ( | ssh_channel | channel, |
const char * | orig_addr, | ||
int | orig_port ) |
Open a X11 channel.
[in] | channel | An allocated channel. |
[in] | orig_addr | The source host (the local server). |
[in] | orig_port | The source port (the local server). |
LIBSSH_API int ssh_channel_request_send_exit_signal | ( | ssh_channel | channel, |
const char * | sig, | ||
int | core, | ||
const char * | errmsg, | ||
const char * | lang ) |
Send an exit signal to remote process (RFC 4254, section 6.10).
This sends the exit status of the remote process. Note, that remote system may not support signals concept. In such a case this request will be silently ignored.
[in] | channel | The channel to send signal. |
[in] | sig | The signal to send (without SIG prefix) (e.g. "TERM" or "KILL"). |
[in] | core | A boolean to tell if a core was dumped |
[in] | errmsg | A CRLF explanation text about the error condition |
[in] | lang | The language used in the message (format: RFC 3066) |
LIBSSH_API int ssh_channel_request_send_exit_status | ( | ssh_channel | channel, |
int | exit_status ) |
Send the exit status to the remote process.
Sends the exit status to the remote process (as described in RFC 4254, section 6.10).
[in] | channel | The channel to send exit status. |
[in] | exit_status | The exit status to send |
LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds | ( | ssh_session | session | ) |
returns the client credentials of the connected client. If the client has given a forwardable token, the SSH server will retrieve it.
int ssh_handle_key_exchange | ( | ssh_session | session | ) |
Handles the key exchange and set up encryption.
session | A connected ssh session |
int ssh_message_auth_kbdint_is_response | ( | ssh_message | msg | ) |
Check if the message is a keyboard-interactive response.
msg | The message to check |
const char * ssh_message_auth_password | ( | ssh_message | msg | ) |
Get the password of the authenticated user.
[in] | msg | The message to get the password from. |
ssh_key ssh_message_auth_pubkey | ( | ssh_message | msg | ) |
Get the publickey of the authenticated user.
If you need the key for later user you should duplicate it.
[in] | msg | The message to get the public key from. |
enum ssh_publickey_state_e ssh_message_auth_publickey_state | ( | ssh_message | msg | ) |
[in] | msg | The message to get the public key state from. |
int ssh_message_auth_reply_pk_ok | ( | ssh_message | msg, |
ssh_string | algo, | ||
ssh_string | pubkey ) |
Answer SSH2_MSG_USERAUTH_PK_OK to a pubkey authentication request.
msg | The message |
algo | The algorithm of the accepted public key |
pubkey | The accepted public key |
int ssh_message_auth_reply_pk_ok_simple | ( | ssh_message | msg | ) |
Answer SSH2_MSG_USERAUTH_PK_OK to a pubkey authentication request.
msg | The message |
int ssh_message_auth_set_methods | ( | ssh_message | msg, |
int | methods ) |
Sets the supported authentication methods to a message.
msg | The message |
methods | Methods to set to the message. The supported methods are listed in ssh_set_auth_methods |
const char * ssh_message_auth_user | ( | ssh_message | msg | ) |
Get the name of the authenticated user.
[in] | msg | The message to get the username from. |
int ssh_message_global_request_reply_success | ( | ssh_message | msg, |
uint16_t | bound_port ) |
Send a global request success message.
msg | The message |
bound_port | The remote bind port |
int ssh_message_reply_default | ( | ssh_message | msg | ) |
Reply with a standard reject message.
Use this function if you don't know what to respond or if you want to reject a request.
[in] | msg | The message to use for the reply. |
int ssh_message_service_reply_success | ( | ssh_message | msg | ) |
Sends SERVICE_ACCEPT to the client.
msg | The message to reply to |
const char * ssh_message_service_service | ( | ssh_message | msg | ) |
Gets the service name from the service request message.
msg | The service request message |
int ssh_send_issue_banner | ( | ssh_session | session, |
const ssh_string | banner ) |
Send the server's issue-banner to client.
[in] | session | The server session. |
[in] | banner | The server's banner. |
int ssh_send_keepalive | ( | ssh_session | session | ) |
Sends a keepalive message to the session.
session | The session to send the message to |
int ssh_server_init_kex | ( | ssh_session | session | ) |
Initialize the set of key exchange, hostkey, ciphers, MACs, and compression algorithms for the given ssh_session.
The selection of algorithms and keys used are determined by the options that are currently set in the given ssh_session structure. May only be called before the initial key exchange has begun.
session | The session structure to initialize. |
void ssh_set_auth_methods | ( | ssh_session | session, |
int | auth_methods ) |
Set the acceptable authentication methods to be sent to the client.
[in] | session | The server session |
[in] | auth_methods | The authentication methods we will support, which can be bitwise-or'd. |
Supported methods are:
SSH_AUTH_METHOD_PASSWORD SSH_AUTH_METHOD_PUBLICKEY SSH_AUTH_METHOD_HOSTBASED SSH_AUTH_METHOD_INTERACTIVE SSH_AUTH_METHOD_GSSAPI_MIC
void ssh_set_message_callback | ( | ssh_session | session, |
int(*)(ssh_session session, ssh_message msg, void *data) | ssh_bind_message_callback, | ||
void * | data ) |
defines the ssh_message callback
session | the current ssh session | |
[in] | ssh_bind_message_callback | a function pointer to a callback taking the current ssh session and received message as parameters. the function returns 0 if the message has been parsed and treated successfully, 1 otherwise (libssh must take care of the response). |
[in] | data | void pointer to be passed to callback functions |