clientloop.h

/* $OpenBSD: clientloop.h,v 1.37 2020/04/03 02:40:32 djm Exp $ */

/*
 * Author: Tatu Ylonen <[email protected]>
 * Copyright (c) 1995 Tatu Ylonen <[email protected]>, Espoo, Finland
 *                    All rights reserved
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */
/*
 * Copyright (c) 2001 Markus Friedl.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <termios.h>

struct ssh;

/* Client side main loop for the interactive session. */
int  client_loop(struct ssh *, int, int, int);
int  client_x11_get_proto(struct ssh *, const char *, const char *,
        u_int, u_int, char **, char **);
void     client_global_request_reply_fwd(int, u_int32_t, void *);
void     client_session2_setup(struct ssh *, int, int, int,
        const char *, struct termios *, int, struct sshbuf *, char **);
char     *client_request_tun_fwd(struct ssh *, int, int, int,
    channel_open_fn *, void *);
void     client_stop_mux(void);

/* Escape filter for protocol 2 sessions */
void    *client_new_escape_filter_ctx(int);
void     client_filter_cleanup(struct ssh *, int, void *);
int  client_simple_escape_filter(struct ssh *, Channel *, char *, int);

/* Global request confirmation callbacks */
typedef void global_confirm_cb(struct ssh *, int, u_int32_t, void *);
void     client_register_global_confirm(global_confirm_cb *, void *);

/* Channel request confirmation callbacks */
enum confirm_action { CONFIRM_WARN = 0, CONFIRM_CLOSE, CONFIRM_TTY };
void client_expect_confirm(struct ssh *, int, const char *,
    enum confirm_action);

/* Multiplexing protocol version */
#define SSHMUX_VER          4

/* Multiplexing control protocol flags */
#define SSHMUX_COMMAND_OPEN     1   /* Open new connection */
#define SSHMUX_COMMAND_ALIVE_CHECK  2   /* Check master is alive */
#define SSHMUX_COMMAND_TERMINATE    3   /* Ask master to exit */
#define SSHMUX_COMMAND_STDIO_FWD    4   /* Open stdio fwd (ssh -W) */
#define SSHMUX_COMMAND_FORWARD      5   /* Forward only, no command */
#define SSHMUX_COMMAND_STOP     6   /* Disable mux but not conn */
#define SSHMUX_COMMAND_CANCEL_FWD   7   /* Cancel forwarding(s) */
#define SSHMUX_COMMAND_PROXY        8   /* Open new connection */

void    muxserver_listen(struct ssh *);
int muxclient(const char *);
void    mux_exit_message(struct ssh *, Channel *, int);
void    mux_tty_alloc_failed(struct ssh *ssh, Channel *);