libssh: server.h Source File

libssh 0.10.4 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
35extern "C" {
36#endif
37
38enum 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 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};
62
63typedef struct ssh_bind_struct* ssh_bind;
64
65/* Callback functions */
66
73 typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
74 void *userdata);
75
81 struct ssh_bind_callbacks_struct {
83 size_t size;
85 ssh_bind_incoming_connection_callback incoming_connection;
86};
87typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
88
94LIBSSH_API ssh_bind ssh_bind_new(void);
95
96LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
97 enum ssh_bind_options_e type, const void *value);
98
99LIBSSH_API int ssh_bind_options_parse_config(ssh_bind sshbind,
100 const char *filename);
101
109LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
110
131LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
132 void *userdata);
133
141LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
142
150LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
151
159LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
160
166LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
167
176LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
177
190LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
191 socket_t fd);
192
193LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
194
202LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
203
220LIBSSH_API int ssh_server_init_kex(ssh_session session);
221
227LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
228
246LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
247
258LIBSSH_API int ssh_send_issue_banner(ssh_session session, const ssh_string banner);
259
260/**********************************************************
261 * SERVER MESSAGING
262 **********************************************************/
263
276LIBSSH_API int ssh_message_reply_default(ssh_message msg);
277
288LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
289
302SSH_DEPRECATED LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
303
320SSH_DEPRECATED LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
321
322LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
323
324/* Replaced by callback based server implementation auth_pubkey_function */
325SSH_DEPRECATED LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg);
326
327LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg,int partial);
328LIBSSH_API int ssh_message_auth_reply_pk_ok(ssh_message msg, ssh_string algo, ssh_string pubkey);
329LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
330
331LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
332
333LIBSSH_API int ssh_message_auth_interactive_request(ssh_message msg,
334 const char *name, const char *instruction,
335 unsigned int num_prompts, const char **prompts, char *echo);
336
337LIBSSH_API int ssh_message_service_reply_success(ssh_message msg);
338LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
339
340LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
341 uint16_t bound_port);
342
343LIBSSH_API void ssh_set_message_callback(ssh_session session,
344 int(*ssh_bind_message_callback)(ssh_session session, ssh_message msg, void *data),
345 void *data);
346LIBSSH_API int ssh_execute_message_callbacks(ssh_session session);
347
348LIBSSH_API const char *ssh_message_channel_request_open_originator(ssh_message msg);
349LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg);
350LIBSSH_API const char *ssh_message_channel_request_open_destination(ssh_message msg);
351LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg);
352
353LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg);
354
355/* Replaced by callback based server implementation function channel_pty_request_function*/
356SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
357SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
358SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
359SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
360SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg);
361
362LIBSSH_API const char *ssh_message_channel_request_env_name(ssh_message msg);
363LIBSSH_API const char *ssh_message_channel_request_env_value(ssh_message msg);
364
365LIBSSH_API const char *ssh_message_channel_request_command(ssh_message msg);
366
367LIBSSH_API const char *ssh_message_channel_request_subsystem(ssh_message msg);
368
369/* Replaced by callback based server implementation function channel_open_request_x11_function*/
370SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
371SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
372SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
373SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg);
374
375LIBSSH_API const char *ssh_message_global_request_address(ssh_message msg);
376LIBSSH_API int ssh_message_global_request_port(ssh_message msg);
377
378LIBSSH_API int ssh_channel_open_reverse_forward(ssh_channel channel, const char *remotehost,
379 int remoteport, const char *sourcehost, int localport);
380LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
381 const char *orig_addr, int orig_port);
382
383LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
384 int exit_status);
385LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
386 const char *signum,
387 int core,
388 const char *errmsg,
389 const char *lang);
390
391LIBSSH_API int ssh_send_keepalive(ssh_session session);
392
393/* deprecated functions */
394SSH_DEPRECATED LIBSSH_API int ssh_accept(ssh_session session);
395SSH_DEPRECATED LIBSSH_API int channel_write_stderr(ssh_channel channel,
396 const void *data, uint32_t len);
397
398#ifdef __cplusplus
399}
400#endif /* __cplusplus */
401
402#endif /* SERVER_H */
403
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:427
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:197
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:373
ssh_bind_new
LIBSSH_API ssh_bind ssh_bind_new(void)
Creates a new SSH server bind.
Definition: bind.c:135
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:574
ssh_message_reply_default
LIBSSH_API int ssh_message_reply_default(ssh_message msg)
Reply with a standard reject message.
Definition: server.c:774
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:3729
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:73
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:1761
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:823
ssh_bind_free
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o)
Free a ssh servers bind.
Definition: bind.c:385
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:305
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:3671
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:815
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:551
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:381
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:582
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:520
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:3773
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:377
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:1159
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:807
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:3607
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:2267
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:526
ssh_bind_listen
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o)
Start listening to the socket.
Definition: bind.c:253
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:369
ssh_bind_callbacks_struct
These are the callbacks exported by the ssh_bind structure.
Definition: server.h:81
ssh_bind_callbacks_struct::incoming_connection
ssh_bind_incoming_connection_callback incoming_connection
Definition: server.h:85
ssh_bind_callbacks_struct::size
size_t size
Definition: server.h:83
ssh_bind_struct
Definition: bind.h:28
ssh_channel_struct
Definition: channels.h:62
ssh_key_struct
Definition: pki.h:54
ssh_message_struct
Definition: messages.h:85
ssh_session_struct
Definition: session.h:110
ssh_string_struct
Definition: string.h:29