server.h
/* Public include file for server support */
/*
* This file is part of the SSH Library
*
* Copyright (c) 2003-2008 by Aris Adamantiadis
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef SERVER_H
#define SERVER_H
#include "libssh/libssh.h"
#define SERVERBANNER CLIENTBANNER
#ifdef __cplusplus
extern "C" {
#endif
enum ssh_bind_options_e {
SSH_BIND_OPTIONS_BINDADDR,
SSH_BIND_OPTIONS_BINDPORT,
SSH_BIND_OPTIONS_BINDPORT_STR,
SSH_BIND_OPTIONS_HOSTKEY,
SSH_BIND_OPTIONS_DSAKEY,
SSH_BIND_OPTIONS_RSAKEY,
SSH_BIND_OPTIONS_BANNER,
SSH_BIND_OPTIONS_LOG_VERBOSITY,
SSH_BIND_OPTIONS_LOG_VERBOSITY_STR,
SSH_BIND_OPTIONS_ECDSAKEY,
SSH_BIND_OPTIONS_IMPORT_KEY,
SSH_BIND_OPTIONS_KEY_EXCHANGE,
SSH_BIND_OPTIONS_CIPHERS_C_S,
SSH_BIND_OPTIONS_CIPHERS_S_C,
SSH_BIND_OPTIONS_HMAC_C_S,
SSH_BIND_OPTIONS_HMAC_S_C,
SSH_BIND_OPTIONS_CONFIG_DIR,
SSH_BIND_OPTIONS_PUBKEY_ACCEPTED_KEY_TYPES,
SSH_BIND_OPTIONS_HOSTKEY_ALGORITHMS,
SSH_BIND_OPTIONS_PROCESS_CONFIG,
};
typedef struct ssh_bind_struct* ssh_bind;
/* Callback functions */
typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
void *userdata);
struct ssh_bind_callbacks_struct {
size_t size;
ssh_bind_incoming_connection_callback incoming_connection;
};
typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
LIBSSH_API ssh_bind ssh_bind_new(void);
LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
enum ssh_bind_options_e type, const void *value);
LIBSSH_API int ssh_bind_options_parse_config(ssh_bind sshbind,
const char *filename);
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
void *userdata);
LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
socket_t fd);
LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
LIBSSH_API int ssh_server_init_kex(ssh_session session);
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
/**********************************************************
* SERVER MESSAGING
**********************************************************/
LIBSSH_API int ssh_message_reply_default(ssh_message msg);
LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
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);
LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
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);
LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
uint16_t bound_port);
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);
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);
LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
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);
LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
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);
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
const char *orig_addr, int orig_port);
LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
int exit_status);
LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
const char *signum,
int core,
const char *errmsg,
const char *lang);
LIBSSH_API int ssh_send_keepalive(ssh_session session);
/* deprecated functions */
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);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* SERVER_H */
ssh_bind_accept_fd
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.
Definition: bind.c:424
ssh_server_init_kex
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 ...
Definition: server.c:207
ssh_bind_get_fd
LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o)
Recover the file descriptor from the session.
Definition: bind.c:371
ssh_bind_new
LIBSSH_API ssh_bind ssh_bind_new(void)
Creates a new SSH server bind.
Definition: bind.c:133
ssh_bind_accept
LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session)
Accept an incoming ssh connection and initialize the session.
Definition: bind.c:554
ssh_message_reply_default
LIBSSH_API int ssh_message_reply_default(ssh_message msg)
Reply with a standard reject message.
Definition: server.c:762
ssh_channel_request_send_exit_status
LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel, int exit_status)
Send the exit status to the remote process.
Definition: channels.c:3607
ssh_bind_incoming_connection_callback
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.
Definition: server.h:71
ssh_bind_options_set
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.
Definition: options.c:1642
ssh_message_auth_pubkey
LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg)
Get the publickey of the authenticated user.
Definition: server.c:811
ssh_bind_free
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o)
Free a ssh servers bind.
Definition: bind.c:383
ssh_bind_set_callbacks
LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks, void *userdata)
Set the callback for this bind.
Definition: bind.c:303
ssh_channel_open_x11
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port)
Open a X11 channel.
Definition: channels.c:3548
ssh_message_auth_password
LIBSSH_API const char * ssh_message_auth_password(ssh_message msg)
Get the password of the authenticated user.
Definition: server.c:803
ssh_handle_key_exchange
LIBSSH_API int ssh_handle_key_exchange(ssh_session session)
Handles the key exchange and set up encryption.
Definition: server.c:539
ssh_bind_fd_toaccept
LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o)
Allow the file descriptor to accept new sessions.
Definition: bind.c:379
ssh_gssapi_get_creds
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,...
Definition: gssapi.c:576
ssh_set_auth_methods
LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods)
Set the acceptable authentication methods to be sent to the client.
Definition: server.c:532
ssh_channel_request_send_exit_signal
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).
Definition: channels.c:3652
ssh_bind_set_fd
LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd)
Set the file descriptor for a session.
Definition: bind.c:375
ssh_set_message_callback
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
Definition: server.c:1147
ssh_message_auth_user
LIBSSH_API const char * ssh_message_auth_user(ssh_message msg)
Get the name of the authenticated user.
Definition: server.c:795
ssh_channel_open_reverse_forward
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.
Definition: channels.c:3485
ssh_bind_options_parse_config
LIBSSH_API int ssh_bind_options_parse_config(ssh_bind sshbind, const char *filename)
Parse a ssh bind options configuration file.
Definition: options.c:2081
ssh_bind_listen
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o)
Start listening to the socket.
Definition: bind.c:252
ssh_bind_set_blocking
LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking)
Set the session to blocking/nonblocking mode.
Definition: bind.c:367
ssh_bind_callbacks_struct
These are the callbacks exported by the ssh_bind structure.
Definition: server.h:79
ssh_bind_callbacks_struct::incoming_connection
ssh_bind_incoming_connection_callback incoming_connection
Definition: server.h:83
ssh_bind_callbacks_struct::size
size_t size
Definition: server.h:81
ssh_bind_struct
Definition: bind.h:28
ssh_channel_struct
Definition: channels.h:62
ssh_key_struct
Definition: pki.h:50
ssh_message_struct
Definition: messages.h:84
ssh_session_struct
Definition: session.h:120
ssh_string_struct
Definition: string.h:29