Grid Community Toolkit  6.2.1705709074 (tag: v6.2.20240202)
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
clientloop.h
1 /* $OpenBSD: clientloop.h,v 1.37 2020/04/03 02:40:32 djm Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <[email protected]>
5  * Copyright (c) 1995 Tatu Ylonen <[email protected]>, Espoo, Finland
6  * All rights reserved
7  *
8  * As far as I am concerned, the code I have written for this software
9  * can be used freely for any purpose. Any derived versions of this
10  * software must be clearly marked as such, and if the derived work is
11  * incompatible with the protocol description in the RFC file, it must be
12  * called by a name other than "ssh" or "Secure Shell".
13  */
14 /*
15  * Copyright (c) 2001 Markus Friedl. All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions
19  * are met:
20  * 1. Redistributions of source code must retain the above copyright
21  * notice, this list of conditions and the following disclaimer.
22  * 2. Redistributions in binary form must reproduce the above copyright
23  * notice, this list of conditions and the following disclaimer in the
24  * documentation and/or other materials provided with the distribution.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #include <termios.h>
39 
40 struct ssh;
41 
42 /* Client side main loop for the interactive session. */
43 int client_loop(struct ssh *, int, int, int);
44 int client_x11_get_proto(struct ssh *, const char *, const char *,
45  u_int, u_int, char **, char **);
46 void client_global_request_reply_fwd(int, u_int32_t, void *);
47 void client_session2_setup(struct ssh *, int, int, int,
48  const char *, struct termios *, int, struct sshbuf *, char **);
49 char *client_request_tun_fwd(struct ssh *, int, int, int,
50  channel_open_fn *, void *);
51 void client_stop_mux(void);
52 
53 /* Escape filter for protocol 2 sessions */
54 void *client_new_escape_filter_ctx(int);
55 void client_filter_cleanup(struct ssh *, int, void *);
56 int client_simple_escape_filter(struct ssh *, Channel *, char *, int);
57 
58 /* Global request confirmation callbacks */
59 typedef void global_confirm_cb(struct ssh *, int, u_int32_t, void *);
60 void client_register_global_confirm(global_confirm_cb *, void *);
61 
62 /* Channel request confirmation callbacks */
63 enum confirm_action { CONFIRM_WARN = 0, CONFIRM_CLOSE, CONFIRM_TTY };
64 void client_expect_confirm(struct ssh *, int, const char *,
65  enum confirm_action);
66 
67 /* Multiplexing protocol version */
68 #define SSHMUX_VER 4
69 
70 /* Multiplexing control protocol flags */
71 #define SSHMUX_COMMAND_OPEN 1 /* Open new connection */
72 #define SSHMUX_COMMAND_ALIVE_CHECK 2 /* Check master is alive */
73 #define SSHMUX_COMMAND_TERMINATE 3 /* Ask master to exit */
74 #define SSHMUX_COMMAND_STDIO_FWD 4 /* Open stdio fwd (ssh -W) */
75 #define SSHMUX_COMMAND_FORWARD 5 /* Forward only, no command */
76 #define SSHMUX_COMMAND_STOP 6 /* Disable mux but not conn */
77 #define SSHMUX_COMMAND_CANCEL_FWD 7 /* Cancel forwarding(s) */
78 #define SSHMUX_COMMAND_PROXY 8 /* Open new connection */
79 
80 void muxserver_listen(struct ssh *);
81 int muxclient(const char *);
82 void mux_exit_message(struct ssh *, Channel *, int);
83 void mux_tty_alloc_failed(struct ssh *ssh, Channel *);
84