server.h

/* Public include file for server support */
/*
 * This file is part of the SSH Library
 *
 * Copyright (c) 2003-2008 by Aris Adamantiadis
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
 
#ifndef SERVER_H
#define SERVER_H
 
#include "libssh/libssh.h"
#define SERVERBANNER CLIENTBANNER
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum ssh_bind_options_e {
  SSH_BIND_OPTIONS_BINDADDR,
  SSH_BIND_OPTIONS_BINDPORT,
  SSH_BIND_OPTIONS_BINDPORT_STR,
  SSH_BIND_OPTIONS_HOSTKEY,
  SSH_BIND_OPTIONS_DSAKEY,  /* deprecated */
  SSH_BIND_OPTIONS_RSAKEY,  /* deprecated */
  SSH_BIND_OPTIONS_BANNER,
  SSH_BIND_OPTIONS_LOG_VERBOSITY,
  SSH_BIND_OPTIONS_LOG_VERBOSITY_STR,
  SSH_BIND_OPTIONS_ECDSAKEY,  /* deprecated */
  SSH_BIND_OPTIONS_IMPORT_KEY,
  SSH_BIND_OPTIONS_KEY_EXCHANGE,
  SSH_BIND_OPTIONS_CIPHERS_C_S,
  SSH_BIND_OPTIONS_CIPHERS_S_C,
  SSH_BIND_OPTIONS_HMAC_C_S,
  SSH_BIND_OPTIONS_HMAC_S_C,
  SSH_BIND_OPTIONS_CONFIG_DIR,
  SSH_BIND_OPTIONS_PUBKEY_ACCEPTED_KEY_TYPES,
  SSH_BIND_OPTIONS_HOSTKEY_ALGORITHMS,
  SSH_BIND_OPTIONS_PROCESS_CONFIG,
  SSH_BIND_OPTIONS_MODULI,
  SSH_BIND_OPTIONS_RSA_MIN_SIZE,
};
 
typedef struct ssh_bind_struct* ssh_bind;
 
/* Callback functions */
 
typedef void (*ssh_bind_incoming_connection_callback) (ssh_bind sshbind,
    void *userdata);
 
struct ssh_bind_callbacks_struct {
  size_t size;
  ssh_bind_incoming_connection_callback incoming_connection;
};
typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
 
LIBSSH_API ssh_bind ssh_bind_new(void);
 
LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
    enum ssh_bind_options_e type, const void *value);
 
LIBSSH_API int ssh_bind_options_parse_config(ssh_bind sshbind,
    const char *filename);
 
LIBSSH_API int ssh_bind_listen(ssh_bind ssh_bind_o);
 
LIBSSH_API int ssh_bind_set_callbacks(ssh_bind sshbind, ssh_bind_callbacks callbacks,
    void *userdata);
 
LIBSSH_API void ssh_bind_set_blocking(ssh_bind ssh_bind_o, int blocking);
 
LIBSSH_API socket_t ssh_bind_get_fd(ssh_bind ssh_bind_o);
 
LIBSSH_API void ssh_bind_set_fd(ssh_bind ssh_bind_o, socket_t fd);
 
LIBSSH_API void ssh_bind_fd_toaccept(ssh_bind ssh_bind_o);
 
LIBSSH_API int ssh_bind_accept(ssh_bind ssh_bind_o, ssh_session session);
 
LIBSSH_API int ssh_bind_accept_fd(ssh_bind ssh_bind_o, ssh_session session,
        socket_t fd);
 
LIBSSH_API ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session);
 
LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
 
LIBSSH_API int ssh_server_init_kex(ssh_session session);
 
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
 
LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
 
LIBSSH_API int ssh_send_issue_banner(ssh_session session, const ssh_string banner);
 
/**********************************************************
 * SERVER MESSAGING
 **********************************************************/
 
LIBSSH_API int ssh_message_reply_default(ssh_message msg);
 
LIBSSH_API const char *ssh_message_auth_user(ssh_message msg);
 
SSH_DEPRECATED LIBSSH_API const char *ssh_message_auth_password(ssh_message msg);
 
SSH_DEPRECATED LIBSSH_API ssh_key ssh_message_auth_pubkey(ssh_message msg);
 
LIBSSH_API int ssh_message_auth_kbdint_is_response(ssh_message msg);
 
SSH_DEPRECATED LIBSSH_API enum ssh_publickey_state_e ssh_message_auth_publickey_state(ssh_message msg);
 
LIBSSH_API int ssh_message_auth_reply_success(ssh_message msg,int partial);
LIBSSH_API int ssh_message_auth_reply_pk_ok(ssh_message msg, ssh_string algo, ssh_string pubkey);
LIBSSH_API int ssh_message_auth_reply_pk_ok_simple(ssh_message msg);
 
LIBSSH_API int ssh_message_auth_set_methods(ssh_message msg, int methods);
 
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);
 
LIBSSH_API int ssh_message_service_reply_success(ssh_message msg);
LIBSSH_API const char *ssh_message_service_service(ssh_message msg);
 
LIBSSH_API int ssh_message_global_request_reply_success(ssh_message msg,
                                                        uint16_t bound_port);
 
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);
LIBSSH_API int ssh_execute_message_callbacks(ssh_session session);
 
LIBSSH_API const char *ssh_message_channel_request_open_originator(ssh_message msg);
LIBSSH_API int ssh_message_channel_request_open_originator_port(ssh_message msg);
LIBSSH_API const char *ssh_message_channel_request_open_destination(ssh_message msg);
LIBSSH_API int ssh_message_channel_request_open_destination_port(ssh_message msg);
 
LIBSSH_API ssh_channel ssh_message_channel_request_channel(ssh_message msg);
 
/* Replaced by callback based server implementation function channel_pty_request_function*/
SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_pty_term(ssh_message msg);
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_width(ssh_message msg);
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_height(ssh_message msg);
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxwidth(ssh_message msg);
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_pty_pxheight(ssh_message msg);
 
LIBSSH_API const char *ssh_message_channel_request_env_name(ssh_message msg);
LIBSSH_API const char *ssh_message_channel_request_env_value(ssh_message msg);
 
LIBSSH_API const char *ssh_message_channel_request_command(ssh_message msg);
 
LIBSSH_API const char *ssh_message_channel_request_subsystem(ssh_message msg);
 
/* Replaced by callback based server implementation function channel_open_request_x11_function*/
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_single_connection(ssh_message msg);
SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_x11_auth_protocol(ssh_message msg);
SSH_DEPRECATED LIBSSH_API const char *ssh_message_channel_request_x11_auth_cookie(ssh_message msg);
SSH_DEPRECATED LIBSSH_API int ssh_message_channel_request_x11_screen_number(ssh_message msg);
 
LIBSSH_API const char *ssh_message_global_request_address(ssh_message msg);
LIBSSH_API int ssh_message_global_request_port(ssh_message msg);
 
LIBSSH_API int ssh_channel_open_reverse_forward(ssh_channel channel, const char *remotehost,
    int remoteport, const char *sourcehost, int localport);
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel,
                                        const char *orig_addr, int orig_port);
 
LIBSSH_API int ssh_channel_request_send_exit_status(ssh_channel channel,
                                                int exit_status);
LIBSSH_API int ssh_channel_request_send_exit_signal(ssh_channel channel,
                                                const char *signum,
                                                int core,
                                                const char *errmsg,
                                                const char *lang);
 
LIBSSH_API int ssh_send_keepalive(ssh_session session);
 
/* deprecated functions */
SSH_DEPRECATED LIBSSH_API int ssh_accept(ssh_session session);
SSH_DEPRECATED LIBSSH_API int channel_write_stderr(ssh_channel channel,
        const void *data, uint32_t len);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* SERVER_H */