ssh-base.h

Go to the documentation of this file.

 
#ifndef __SSHBASE_H__
#define __SSHBASE_H__
 
#include <libssh/libssh.h>
 
#include <glib.h>
 
#include <extcap/extcap-base.h>
 
#ifndef STDERR_FILENO
#define STDERR_FILENO 2
#endif
 
#ifndef STDOUT_FILENO
#define STDOUT_FILENO 1
#endif
 
/* Server and Authentication Options */
#define SSH_BASE_OPTIONS \
    { "remote-host", ws_required_argument, NULL, OPT_REMOTE_HOST}, \
    { "remote-port", ws_required_argument, NULL, OPT_REMOTE_PORT}, \
    { "remote-username", ws_required_argument, NULL, OPT_REMOTE_USERNAME}, \
    { "remote-password", ws_required_argument, NULL, OPT_REMOTE_PASSWORD}, \
    { "remote-count", ws_required_argument, NULL, OPT_REMOTE_COUNT}, \
    { "sshkey", ws_required_argument, NULL, OPT_SSHKEY}, \
    { "sshkey-passphrase", ws_required_argument, NULL, OPT_SSHKEY_PASSPHRASE}, \
    { "proxycommand", ws_required_argument, NULL, OPT_PROXYCOMMAND}, \
    { "ssh-sha1", ws_no_argument, NULL, OPT_SSH_SHA1}, \
    { "update-known-hosts", ws_no_argument, NULL, OPT_UPDATE_KNOWN_HOSTS}
 
#define SSH_BASE_OPTIONS_ENUM \
    OPT_REMOTE_HOST, \
    OPT_REMOTE_PORT, \
    OPT_REMOTE_USERNAME, \
    OPT_REMOTE_PASSWORD, \
    OPT_SSHKEY, \
    OPT_SSHKEY_PASSPHRASE, \
    OPT_PROXYCOMMAND, \
    OPT_SSH_SHA1, \
    OPT_UPDATE_KNOWN_HOSTS
 
#define SSH_BASE_PACKET_OPTIONS \
    SSH_BASE_OPTIONS, \
    { "remote-interface", ws_required_argument, NULL, OPT_REMOTE_INTERFACE}, \
    { "remote-filter", ws_required_argument, NULL, OPT_REMOTE_FILTER}
 
#define SSH_BASE_PACKET_OPTIONS_ENUM \
    SSH_BASE_OPTIONS_ENUM, \
    OPT_REMOTE_INTERFACE, \
    OPT_REMOTE_FILTER

typedef struct _ssh_params {
    char*    host;               
    uint16_t port;               
    char*    username;           
    char*    password;           
    char*    sshkey_path;        
    char*    sshkey_passphrase;  
    char*    proxycommand;       
    bool     ssh_sha1;           
    bool     update_known_hosts;
    int      debug;              
} ssh_params_t;

void ssh_base_list_config(unsigned *count);

void ssh_base_add_help_options(extcap_parameters *extcap_conf);
 
/* Add libssh version information to an extcap_parameters structure */

void add_libssh_info(extcap_parameters * extcap_conf);

ssh_session create_ssh_connection(const ssh_params_t* ssh_params, char** err_info);

int ssh_channel_printf(ssh_channel channel, const char* fmt, ...);

bool ssh_base_setup_graceful_shutdown(extcap_parameters *extcap_conf);

int ssh_async_loop_read(ssh_session sshs, ssh_channel channel, FILE* fp);
 
/* Clean the current ssh session and channel. */

void ssh_cleanup(ssh_session* sshs, ssh_channel* channel);
 
/* Init the ssh_params_t structure */

ssh_params_t* ssh_params_new(void);
 
/* Clean the ssh params */

void ssh_params_free(ssh_params_t* ssh_params);
 
/* Sets the libssh log level to match the ws log level */

void ssh_params_set_log_level(ssh_params_t* ssh_params, enum ws_log_level level);
 
#endif
 
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 8
 * tab-width: 8
 * indent-tabs-mode: t
 * End:
 *
 * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 * :indentSize=8:tabSize=8:noTabs=false:
 */