libssh 0.8.5 The SSH library

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
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,
44 SSH_BIND_OPTIONS_RSAKEY,
45 SSH_BIND_OPTIONS_BANNER,
46 SSH_BIND_OPTIONS_LOG_VERBOSITY,
47 SSH_BIND_OPTIONS_LOG_VERBOSITY_STR,
48 SSH_BIND_OPTIONS_ECDSAKEY,
49 SSH_BIND_OPTIONS_IMPORT_KEY
50 };
51
52 typedef struct ssh_bind_struct* ssh_bind;
53
54 /* Callback functions */
55
62 typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
63 void *userdata);
64
70 struct ssh_bind_callbacks_struct {
72 size_t size;
74 ssh_bind_incoming_connection_callback incoming_connection;
75 };
76 typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
77
83 LIBSSH_API ssh_bind ssh_bind_new(void);
84
85 LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
86 enum ssh_bind_options_e type, const void *value);
87
95 LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
96
117 LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
118 void *userdata);
119
127 LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
128
136 LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
137
145 LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
146
152 LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
153
162 LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
163
176 LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
177 socket_t fd);
178
179 LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
180
188 LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
189
206 LIBSSH_API int ssh_server_init_kex(ssh_session session);
207
213 LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
214
232 LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
233
234 /**********************************************************
235 * SERVER MESSAGING
236 **********************************************************/
237
250 LIBSSH_API int ssh_message_reply_default(ssh_message msg);
251
262 LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
263
274 LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
275
290 LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
291
292 LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
293 LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg);
294 LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg,int partial);
295 LIBSSH_API int ssh_message_auth_reply_pk_ok(ssh_message msg, ssh_string algo, ssh_string pubkey);
296 LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
297
298 LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
299
300 LIBSSH_API int ssh_message_auth_interactive_request(ssh_message msg,
301 const char *name, const char *instruction,
302 unsigned int num_prompts, const char **prompts, char *echo);
303
304 LIBSSH_API int ssh_message_service_reply_success(ssh_message msg);
305 LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
306
307 LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
308 uint16_t bound_port);
309
310 LIBSSH_API void ssh_set_message_callback(ssh_session session,
311 int(*ssh_bind_message_callback)(ssh_session session, ssh_message msg, void *data),
312 void *data);
313 LIBSSH_API int ssh_execute_message_callbacks(ssh_session session);
314
315 LIBSSH_API const char *ssh_message_channel_request_open_originator(ssh_message msg);
316 LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg);
317 LIBSSH_API const char *ssh_message_channel_request_open_destination(ssh_message msg);
318 LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg);
319
320 LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg);
321
322 LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
323 LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
324 LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
325 LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
326 LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg);
327
328 LIBSSH_API const char *ssh_message_channel_request_env_name(ssh_message msg);
329 LIBSSH_API const char *ssh_message_channel_request_env_value(ssh_message msg);
330
331 LIBSSH_API const char *ssh_message_channel_request_command(ssh_message msg);
332
333 LIBSSH_API const char *ssh_message_channel_request_subsystem(ssh_message msg);
334
335 LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
336 LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
337 LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
338 LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg);
339
340 LIBSSH_API const char *ssh_message_global_request_address(ssh_message msg);
341 LIBSSH_API int ssh_message_global_request_port(ssh_message msg);
342
343 LIBSSH_API int ssh_channel_open_reverse_forward(ssh_channel channel, const char *remotehost,
344 int remoteport, const char *sourcehost, int localport);
345 LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
346 const char *orig_addr, int orig_port);
347
348 LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
349 int exit_status);
350 LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
351 const char *signum,
352 int core,
353 const char *errmsg,
354 const char *lang);
355
356 LIBSSH_API int ssh_send_keepalive(ssh_session session);
357
358 /* deprecated functions */
359 SSH_DEPRECATED LIBSSH_API int ssh_accept(ssh_session session);
360 SSH_DEPRECATED LIBSSH_API int channel_write_stderr(ssh_channel channel,
361 const void *data, uint32_t len);
362
363 #ifdef __cplusplus
364 }
365 #endif /* __cplusplus */
366
367 #endif /* SERVER_H */
368
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:354
ssh_key_struct
Definition: pki.h:42
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:505
ssh_message_struct
Definition: messages.h:84
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:621
ssh_channel_struct
Definition: channels.h:57
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:891
ssh_bind_struct
Definition: bind.h:27
ssh_session_struct
Definition: session.h:102
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:883
ssh_bind_free
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o)
Free a ssh servers bind.
Definition: bind.c:370
ssh_bind_new
LIBSSH_API ssh_bind ssh_bind_new(void)
Creates a new SSH server bind.
Definition: bind.c:132
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:358
ssh_message_reply_default
LIBSSH_API int ssh_message_reply_default(ssh_message msg)
Reply with a standard reject message.
Definition: server.c:850
ssh_string_struct
Definition: string.h:29
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:627
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:1217
ssh_bind_callbacks_struct
These are the callbacks exported by the ssh_bind structure.
Definition: server.h:70
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:899
ssh_bind_callbacks_struct::size
size_t size
Definition: server.h:72
ssh_bind_callbacks_struct::incoming_connection
ssh_bind_incoming_connection_callback incoming_connection
Definition: server.h:74
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:409
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:302
ssh_bind_listen
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o)
Start listening to the socket.
Definition: bind.c:251
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:62
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_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:366
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:164