libssh 0.12.1 The SSH library

Loading...
Searching...
No Matches
server.h
1/* Public include file for server support */
2/*
3 * This file is part of the SSH Library
4 *
5 * Copyright (c) 2003-2008 by Aris Adamantiadis
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
27
28#ifndef SERVER_H
29#define SERVER_H
30
31#include "libssh/libssh.h"
32#define SERVERBANNER CLIENTBANNER
33
34#ifdef __cplusplus
35 extern "C" {
36#endif
37
38 enum ssh_bind_options_e {
39 SSH_BIND_OPTIONS_BINDADDR,
40 SSH_BIND_OPTIONS_BINDPORT,
41 SSH_BIND_OPTIONS_BINDPORT_STR,
42 SSH_BIND_OPTIONS_HOSTKEY,
43 SSH_BIND_OPTIONS_DSAKEY, /* deprecated */
44 SSH_BIND_OPTIONS_RSAKEY, /* deprecated */
45 SSH_BIND_OPTIONS_BANNER,
46 SSH_BIND_OPTIONS_LOG_VERBOSITY,
47 SSH_BIND_OPTIONS_LOG_VERBOSITY_STR,
48 SSH_BIND_OPTIONS_ECDSAKEY, /* deprecated */
49 SSH_BIND_OPTIONS_IMPORT_KEY,
50 SSH_BIND_OPTIONS_KEY_EXCHANGE,
51 SSH_BIND_OPTIONS_CIPHERS_C_S,
52 SSH_BIND_OPTIONS_CIPHERS_S_C,
53 SSH_BIND_OPTIONS_HMAC_C_S,
54 SSH_BIND_OPTIONS_HMAC_S_C,
55 SSH_BIND_OPTIONS_CONFIG_DIR,
56 SSH_BIND_OPTIONS_PUBKEY_ACCEPTED_KEY_TYPES,
57 SSH_BIND_OPTIONS_HOSTKEY_ALGORITHMS,
58 SSH_BIND_OPTIONS_PROCESS_CONFIG,
59 SSH_BIND_OPTIONS_MODULI,
60 SSH_BIND_OPTIONS_RSA_MIN_SIZE,
61 SSH_BIND_OPTIONS_IMPORT_KEY_STR,
62 SSH_BIND_OPTIONS_GSSAPI_KEY_EXCHANGE,
63 SSH_BIND_OPTIONS_GSSAPI_KEY_EXCHANGE_ALGS,
64};
65
66 typedef struct ssh_bind_struct* ssh_bind;
67
68/* Callback functions */
69
76 typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
77 void *userdata);
78
84 struct ssh_bind_callbacks_struct {
86 size_t size;
88 ssh_bind_incoming_connection_callback incoming_connection;
89};
90 typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
91
97LIBSSH_API ssh_bind ssh_bind_new(void);
98
99LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
100 enum ssh_bind_options_e type, const void *value);
101
102LIBSSH_API int ssh_bind_options_parse_config(ssh_bind sshbind,
103 const char *filename);
104
112LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
113
134LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
135 void *userdata);
136
144LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
145
153LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
154
162LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
163
169LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
170
179LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
180
193LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
194 socket_t fd);
195
196LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
197
205LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
206
222LIBSSH_API int ssh_server_init_kex(ssh_session session);
223
232LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
233
252LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
253
264LIBSSH_API int ssh_send_issue_banner(ssh_session session, const ssh_string banner);
265
266/**********************************************************
267 * SERVER MESSAGING
268 **********************************************************/
269
282LIBSSH_API int ssh_message_reply_default(ssh_message msg);
283
294LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
295
308SSH_DEPRECATED LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
309
326SSH_DEPRECATED LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
327
328LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
329
336SSH_DEPRECATED LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg);
337
338LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg,int partial);
339LIBSSH_API int ssh_message_auth_reply_pk_ok(ssh_message msg, ssh_string algo, ssh_string pubkey);
340LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
341
342LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
343
344LIBSSH_API int ssh_message_auth_interactive_request(ssh_message msg,
345 const char *name, const char *instruction,
346 unsigned int num_prompts, const char **prompts, char *echo);
347
348LIBSSH_API int ssh_message_service_reply_success(ssh_message msg);
349LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
350
351LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
352 uint16_t bound_port);
353
354LIBSSH_API void ssh_set_message_callback(ssh_session session,
355 int(*ssh_bind_message_callback)(ssh_session session, ssh_message msg, void *data),
356 void *data);
357LIBSSH_API int ssh_execute_message_callbacks(ssh_session session);
358
359LIBSSH_API const char *ssh_message_channel_request_open_originator(ssh_message msg);
360LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg);
361LIBSSH_API const char *ssh_message_channel_request_open_destination(ssh_message msg);
362LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg);
363
364LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg);
365
366/* Replaced by callback based server implementation function channel_pty_request_function*/
367SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
368SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
369SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
370SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
371SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg);
372
373LIBSSH_API const char *ssh_message_channel_request_env_name(ssh_message msg);
374LIBSSH_API const char *ssh_message_channel_request_env_value(ssh_message msg);
375
376LIBSSH_API const char *ssh_message_channel_request_command(ssh_message msg);
377
378LIBSSH_API const char *ssh_message_channel_request_subsystem(ssh_message msg);
379
380/* Replaced by callback based server implementation function channel_open_request_x11_function*/
381SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
382SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
383SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
384SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg);
385
386LIBSSH_API const char *ssh_message_global_request_address(ssh_message msg);
387LIBSSH_API int ssh_message_global_request_port(ssh_message msg);
388
389LIBSSH_API int ssh_channel_open_reverse_forward(ssh_channel channel, const char *remotehost,
390 int remoteport, const char *sourcehost, int localport);
391LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
392 const char *orig_addr, int orig_port);
393
394LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
395 int exit_status);
396LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
397 const char *signum,
398 int core,
399 const char *errmsg,
400 const char *lang);
401
402LIBSSH_API int ssh_send_keepalive(ssh_session session);
403
404/* deprecated functions */
405SSH_DEPRECATED LIBSSH_API int ssh_accept(ssh_session session);
406SSH_DEPRECATED LIBSSH_API int channel_write_stderr(ssh_channel channel,
407 const void *data, uint32_t len);
408
409#ifdef __cplusplus
410}
411#endif /* __cplusplus */
412
413#endif /* SERVER_H */
414
ssh_message_channel_request_pty_term
SSH_DEPRECATED LIBSSH_API const char * ssh_message_channel_request_pty_term(ssh_message msg)
Get the terminal type from the message.
Definition server.c:1387
ssh_message_channel_request_open_originator
LIBSSH_API const char * ssh_message_channel_request_open_originator(ssh_message msg)
Get the originator address from the channel open message.
Definition server.c:1327
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:412
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:235
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:357
ssh_message_channel_request_x11_auth_cookie
SSH_DEPRECATED LIBSSH_API const char * ssh_message_channel_request_x11_auth_cookie(ssh_message msg)
Get the X11 authentication cookie from the message.
Definition server.c:1546
ssh_message_auth_reply_pk_ok
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.
Definition server.c:1268
ssh_message_global_request_port
LIBSSH_API int ssh_message_global_request_port(ssh_message msg)
Get the bind port from the global request message.
Definition server.c:1585
ssh_message_channel_request_open_destination
LIBSSH_API const char * ssh_message_channel_request_open_destination(ssh_message msg)
Get the destination address from the channel open message.
Definition server.c:1349
ssh_message_global_request_address
LIBSSH_API const char * ssh_message_global_request_address(ssh_message msg)
Get the bind address from the global request message.
Definition server.c:1574
ssh_bind_new
LIBSSH_API ssh_bind ssh_bind_new(void)
Creates a new SSH server bind.
Definition bind.c:135
ssh_message_auth_kbdint_is_response
LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg)
Check if the message is a keyboard-interactive response.
Definition server.c:1024
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:568
ssh_message_reply_default
LIBSSH_API int ssh_message_reply_default(ssh_message msg)
Reply with a standard reject message.
Definition server.c:938
ssh_message_channel_request_pty_width
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg)
Get the terminal width from the message.
Definition server.c:1403
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:4001
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:76
ssh_message_channel_request_channel
LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg)
Get the channel associated with the message.
Definition server.c:1371
ssh_message_channel_request_env_value
LIBSSH_API const char * ssh_message_channel_request_env_value(ssh_message msg)
Get the value of the environment variable from the message.
Definition server.c:1473
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:2406
ssh_message_channel_request_command
LIBSSH_API const char * ssh_message_channel_request_command(ssh_message msg)
Get the command from a channel request message.
Definition server.c:1484
ssh_message_auth_pubkey
SSH_DEPRECATED LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg)
Get the publickey of the authenticated user.
Definition server.c:994
ssh_message_auth_reply_pk_ok_simple
LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg)
Answer SSH2_MSG_USERAUTH_PK_OK to a pubkey authentication request.
Definition server.c:1295
ssh_message_global_request_reply_success
LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg, uint16_t bound_port)
Send a global request success message.
Definition server.c:872
ssh_message_service_service
LIBSSH_API const char * ssh_message_service_service(ssh_message msg)
Gets the service name from the service request message.
Definition server.c:971
ssh_message_channel_request_pty_pxwidth
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg)
Get the terminal pixel width from the message.
Definition server.c:1435
ssh_message_channel_request_x11_single_connection
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg)
Check if the X11 request is for a single connection.
Definition server.c:1512
ssh_send_keepalive
LIBSSH_API int ssh_send_keepalive(ssh_session session)
Sends a keepalive message to the session.
Definition server.c:1648
ssh_message_channel_request_env_name
LIBSSH_API const char * ssh_message_channel_request_env_name(ssh_message msg)
Get the name of the environment variable from the message.
Definition server.c:1462
ssh_bind_free
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o)
Free a ssh servers bind.
Definition bind.c:372
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:287
ssh_message_auth_interactive_request
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)
Sends an interactive authentication request message.
Definition server.c:1080
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:3946
ssh_message_auth_password
SSH_DEPRECATED LIBSSH_API const char * ssh_message_auth_password(ssh_message msg)
Get the password of the authenticated user.
Definition server.c:986
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:642
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:367
ssh_message_auth_set_methods
LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods)
Sets the supported authentication methods to a message.
Definition server.c:1044
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:607
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:610
ssh_message_auth_reply_success
LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg, int partial)
Replies to an authentication request with success.
Definition server.c:1251
ssh_execute_message_callbacks
LIBSSH_API int ssh_execute_message_callbacks(ssh_session session)
Execute callbacks for the messages in the queue.
Definition server.c:1611
ssh_message_channel_request_pty_height
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg)
Get the terminal height from the message.
Definition server.c:1419
ssh_message_channel_request_x11_auth_protocol
SSH_DEPRECATED LIBSSH_API const char * ssh_message_channel_request_x11_auth_protocol(ssh_message msg)
Get the X11 authentication protocol from the message.
Definition server.c:1529
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:4045
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:362
ssh_message_channel_request_pty_pxheight
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg)
Get the terminal pixel height from the message.
Definition server.c:1451
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:1597
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:978
ssh_message_service_reply_success
LIBSSH_API int ssh_message_service_reply_success(ssh_message msg)
Sends SSH2_MSG_SERVICE_ACCEPT to the client.
Definition server.c:838
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:3882
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:2927
ssh_send_issue_banner
LIBSSH_API int ssh_send_issue_banner(ssh_session session, const ssh_string banner)
Send the server's issue-banner to client.
Definition server.c:616
ssh_bind_listen
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o)
Start listening to the socket.
Definition bind.c:221
ssh_message_channel_request_subsystem
LIBSSH_API const char * ssh_message_channel_request_subsystem(ssh_message msg)
Get the subsystem from a channel request message.
Definition server.c:1495
ssh_message_channel_request_open_originator_port
LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg)
Get the originator port from the channel open message.
Definition server.c:1338
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:352
ssh_message_channel_request_x11_screen_number
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg)
Get the X11 screen number from the message.
Definition server.c:1563
ssh_message_channel_request_open_destination_port
LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg)
Get the destination port from the channel open message.
Definition server.c:1360
ssh_message_auth_publickey_state
SSH_DEPRECATED LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg)
Definition server.c:1010
ssh_bind_callbacks_struct
These are the callbacks exported by the ssh_bind structure.
Definition server.h:84
ssh_bind_callbacks_struct::incoming_connection
ssh_bind_incoming_connection_callback incoming_connection
Definition server.h:88
ssh_bind_callbacks_struct::size
size_t size
Definition server.h:86