libssh: include/libssh/server.h Source File

libssh 0.7.5

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 };
50
51 typedef struct ssh_bind_struct* ssh_bind;
52
53 /* Callback functions */
54
61 typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
62 void *userdata);
63
69 struct ssh_bind_callbacks_struct {
71 size_t size;
73 ssh_bind_incoming_connection_callback incoming_connection;
74 };
75 typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
76
82 LIBSSH_API ssh_bind ssh_bind_new(void);
83
84 LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
85 enum ssh_bind_options_e type, const void *value);
86
94 LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
95
116 LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
117 void *userdata);
118
126 LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
127
135 LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
136
144 LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
145
151 LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
152
161 LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
162
175 LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
176 socket_t fd);
177
178 LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
179
187 LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
188
194 LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
195
196 LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
197
198 /**********************************************************
199 * SERVER MESSAGING
200 **********************************************************/
201
214 LIBSSH_API int ssh_message_reply_default(ssh_message msg);
215
226 LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
227
238 LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
239
254 LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
255
256 LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
257 LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg);
258 LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg,int partial);
259 LIBSSH_API int ssh_message_auth_reply_pk_ok(ssh_message msg, ssh_string algo, ssh_string pubkey);
260 LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
261
262 LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
263
264 LIBSSH_API int ssh_message_auth_interactive_request(ssh_message msg,
265 const char *name, const char *instruction,
266 unsigned int num_prompts, const char **prompts, char *echo);
267
268 LIBSSH_API int ssh_message_service_reply_success(ssh_message msg);
269 LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
270
271 LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
272 uint16_t bound_port);
273
274 LIBSSH_API void ssh_set_message_callback(ssh_session session,
275 int(*ssh_bind_message_callback)(ssh_session session, ssh_message msg, void *data),
276 void *data);
277 LIBSSH_API int ssh_execute_message_callbacks(ssh_session session);
278
279 LIBSSH_API const char *ssh_message_channel_request_open_originator(ssh_message msg);
280 LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg);
281 LIBSSH_API const char *ssh_message_channel_request_open_destination(ssh_message msg);
282 LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg);
283
284 LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg);
285
286 LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
287 LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
288 LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
289 LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
290 LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg);
291
292 LIBSSH_API const char *ssh_message_channel_request_env_name(ssh_message msg);
293 LIBSSH_API const char *ssh_message_channel_request_env_value(ssh_message msg);
294
295 LIBSSH_API const char *ssh_message_channel_request_command(ssh_message msg);
296
297 LIBSSH_API const char *ssh_message_channel_request_subsystem(ssh_message msg);
298
299 LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
300 LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
301 LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
302 LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg);
303
304 LIBSSH_API const char *ssh_message_global_request_address(ssh_message msg);
305 LIBSSH_API int ssh_message_global_request_port(ssh_message msg);
306
307 LIBSSH_API int ssh_channel_open_reverse_forward(ssh_channel channel, const char *remotehost,
308 int remoteport, const char *sourcehost, int localport);
309 LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
310 const char *orig_addr, int orig_port);
311
312 LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
313 int exit_status);
314 LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
315 const char *signum,
316 int core,
317 const char *errmsg,
318 const char *lang);
319 LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel,
320 const void *data,
321 uint32_t len);
322
323 LIBSSH_API int ssh_send_keepalive(ssh_session session);
324
325 /* deprecated functions */
326 SSH_DEPRECATED LIBSSH_API int ssh_accept(ssh_session session);
327 SSH_DEPRECATED LIBSSH_API int channel_write_stderr(ssh_channel channel,
328 const void *data, uint32_t len);
329
330 #ifdef __cplusplus
331 }
332 #endif /* __cplusplus */
333
334 #endif /* SERVER_H */
335
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:329
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:474
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 client.
Definition: server.c:558
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:3267
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:828
ssh_gssapi_get_creds
LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session)
returns the client credentials of the connected client.
Definition: gssapi.c:547
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:3377
ssh_bind_callbacks_struct::incoming_connection
ssh_bind_incoming_connection_callback incoming_connection
A new connection is available.
Definition: server.h:73
ssh_channel_write_stderr
LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel stderr.
Definition: channels.c:3176
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:820
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:1387
ssh_bind_free
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o)
Free a ssh servers bind.
Definition: bind.c:345
ssh_bind_new
LIBSSH_API ssh_bind ssh_bind_new(void)
Creates a new SSH server bind.
Definition: bind.c:132
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:3326
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:333
ssh_message_reply_default
LIBSSH_API int ssh_message_reply_default(ssh_message msg)
Reply with a standard reject message.
Definition: server.c:787
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:564
ssh_bind_callbacks_struct::size
size_t size
DON&#39;T SET THIS use ssh_callbacks_init() instead.
Definition: server.h:71
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:1153
ssh_bind_callbacks_struct
These are the callbacks exported by the ssh_bind structure.
Definition: server.h:69
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:836
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:3204
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:384
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:277
ssh_bind_listen
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o)
Start listening to the socket.
Definition: bind.c:228
ssh_bind_incoming_connection_callback
void(* ssh_bind_incoming_connection_callback)(ssh_bind sshbind, void *userdata)
Incoming connection callback.
Definition: server.h:61
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:337
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:341