xref: /freebsd/crypto/openssh/clientloop.h (revision 8ef24a0d4b28fe230e20637f56869cc4148cd2ca)
1 /* $OpenBSD: clientloop.h,v 1.32 2016/01/13 23:04:47 djm Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, 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 /* Client side main loop for the interactive session. */
41 int	 client_loop(int, int, int);
42 int	 client_x11_get_proto(const char *, const char *, u_int, u_int,
43 	    char **, char **);
44 void	 client_global_request_reply_fwd(int, u_int32_t, void *);
45 void	 client_session2_setup(int, int, int, const char *, struct termios *,
46 	    int, Buffer *, char **);
47 int	 client_request_tun_fwd(int, int, int);
48 void	 client_stop_mux(void);
49 
50 /* Escape filter for protocol 2 sessions */
51 void	*client_new_escape_filter_ctx(int);
52 void	 client_filter_cleanup(int, void *);
53 int	 client_simple_escape_filter(Channel *, char *, int);
54 
55 /* Global request confirmation callbacks */
56 typedef void global_confirm_cb(int, u_int32_t seq, void *);
57 void	 client_register_global_confirm(global_confirm_cb *, void *);
58 
59 /* Channel request confirmation callbacks */
60 enum confirm_action { CONFIRM_WARN = 0, CONFIRM_CLOSE, CONFIRM_TTY };
61 void client_expect_confirm(int, const char *, enum confirm_action);
62 
63 /* Multiplexing protocol version */
64 #define SSHMUX_VER			4
65 
66 /* Multiplexing control protocol flags */
67 #define SSHMUX_COMMAND_OPEN		1	/* Open new connection */
68 #define SSHMUX_COMMAND_ALIVE_CHECK	2	/* Check master is alive */
69 #define SSHMUX_COMMAND_TERMINATE	3	/* Ask master to exit */
70 #define SSHMUX_COMMAND_STDIO_FWD	4	/* Open stdio fwd (ssh -W) */
71 #define SSHMUX_COMMAND_FORWARD		5	/* Forward only, no command */
72 #define SSHMUX_COMMAND_STOP		6	/* Disable mux but not conn */
73 #define SSHMUX_COMMAND_CANCEL_FWD	7	/* Cancel forwarding(s) */
74 
75 void	muxserver_listen(void);
76 void	muxclient(const char *);
77 void	mux_exit_message(Channel *, int);
78 void	mux_tty_alloc_failed(Channel *);
79 
80