libssh  0.6.3
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 };
49 
50 typedef struct ssh_bind_struct* ssh_bind;
51 
52 /* Callback functions */
53 
60 typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
61  void *userdata);
62 
70  size_t size;
73 };
74 typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
75 
81 LIBSSH_API ssh_bind ssh_bind_new(void);
82 
146 LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
147  enum ssh_bind_options_e type, const void *value);
148 
156 LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
157 
178 LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
179  void *userdata);
180 
188 LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
189 
197 LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
198 
206 LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
207 
213 LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
214 
223 LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
224 
237 LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
238  socket_t fd);
239 
240 LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
241 
249 LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
250 
256 LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
257 
258 LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
259 
260 /**********************************************************
261  * SERVER MESSAGING
262  **********************************************************/
263 
276 LIBSSH_API int ssh_message_reply_default(ssh_message msg);
277 
288 LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
289 
300 LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
301 
316 LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
317 
318 LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
319 LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg);
320 LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg,int partial);
321 LIBSSH_API int ssh_message_auth_reply_pk_ok(ssh_message msg, ssh_string algo, ssh_string pubkey);
322 LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
323 
324 LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
325 
326 LIBSSH_API int ssh_message_auth_interactive_request(ssh_message msg,
327  const char *name, const char *instruction,
328  unsigned int num_prompts, const char **prompts, char *echo);
329 
330 LIBSSH_API int ssh_message_service_reply_success(ssh_message msg);
331 LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
332 
333 LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
334  uint16_t bound_port);
335 
336 LIBSSH_API void ssh_set_message_callback(ssh_session session,
337  int(*ssh_bind_message_callback)(ssh_session session, ssh_message msg, void *data),
338  void *data);
339 LIBSSH_API int ssh_execute_message_callbacks(ssh_session session);
340 
341 LIBSSH_API const char *ssh_message_channel_request_open_originator(ssh_message msg);
342 LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg);
343 LIBSSH_API const char *ssh_message_channel_request_open_destination(ssh_message msg);
344 LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg);
345 
346 LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg);
347 
348 LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
349 LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
350 LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
351 LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
352 LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg);
353 
354 LIBSSH_API const char *ssh_message_channel_request_env_name(ssh_message msg);
355 LIBSSH_API const char *ssh_message_channel_request_env_value(ssh_message msg);
356 
357 LIBSSH_API const char *ssh_message_channel_request_command(ssh_message msg);
358 
359 LIBSSH_API const char *ssh_message_channel_request_subsystem(ssh_message msg);
360 
361 LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
362 LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
363 LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
364 LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg);
365 
366 LIBSSH_API const char *ssh_message_global_request_address(ssh_message msg);
367 LIBSSH_API int ssh_message_global_request_port(ssh_message msg);
368 
369 LIBSSH_API int ssh_channel_open_reverse_forward(ssh_channel channel, const char *remotehost,
370  int remoteport, const char *sourcehost, int localport);
371 LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
372  const char *orig_addr, int orig_port);
373 
374 LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
375  int exit_status);
376 LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
377  const char *signum,
378  int core,
379  const char *errmsg,
380  const char *lang);
381 LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel,
382  const void *data,
383  uint32_t len);
384 
385 LIBSSH_API int ssh_send_keepalive(ssh_session session);
386 
387 /* deprecated functions */
388 SSH_DEPRECATED LIBSSH_API int ssh_accept(ssh_session session);
389 SSH_DEPRECATED LIBSSH_API int channel_write_stderr(ssh_channel channel,
390  const void *data, uint32_t len);
391 
392 #ifdef __cplusplus
393 }
394 #endif /* __cplusplus */
395 
396 #endif /* SERVER_H */
397 
LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking)
Set the session to blocking/nonblocking mode.
Definition: bind.c:328
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:466
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:536
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port)
Open a X11 channel.
Definition: channels.c:3388
LIBSSH_API const char * ssh_message_auth_password(ssh_message msg)
Get the password of the authenticated user.
Definition: server.c:828
LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session)
returns the client credentials of the connected client.
Definition: gssapi.c:537
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 (as described in RFC 4254, section 6.10).
Definition: channels.c:3502
ssh_bind_incoming_connection_callback incoming_connection
A new connection is available.
Definition: server.h:72
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:3280
LIBSSH_API const char * ssh_message_auth_user(ssh_message msg)
Get the name of the authenticated user.
Definition: server.c:820
LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind, enum ssh_bind_options_e type, const void *value)
Set the options for the current SSH server bind.
Definition: options.c:1352
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o)
Free a ssh servers bind.
Definition: bind.c:344
LIBSSH_API ssh_bind ssh_bind_new(void)
Creates a new SSH server bind.
Definition: bind.c:132
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:3452
LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o)
Recover the file descriptor from the session.
Definition: bind.c:332
LIBSSH_API int ssh_message_reply_default(ssh_message msg)
Reply with a standard reject message.
Definition: server.c:787
LIBSSH_API int ssh_handle_key_exchange(ssh_session session)
Handles the key exchange and set up encryption.
Definition: server.c:542
size_t size
DON'T SET THIS use ssh_callbacks_init() instead.
Definition: server.h:70
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:1189
These are the callbacks exported by the ssh_bind structure.
Definition: server.h:68
LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg)
Get the publickey of the authenticated user.
Definition: server.c:836
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:3308
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
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:276
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o)
Start listening to the socket.
Definition: bind.c:228
void(* ssh_bind_incoming_connection_callback)(ssh_bind sshbind, void *userdata)
Incoming connection callback.
Definition: server.h:60
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:336
LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o)
Allow the file descriptor to accept new sessions.
Definition: bind.c:340