1 /* $OpenBSD: channels.h,v 1.104 2010/05/14 23:29:23 djm Exp $ */
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
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".
15 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
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.
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.
41 /* Definitions for channel types. */
42 #define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
43 #define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
44 #define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
45 #define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
46 #define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
47 #define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
48 #define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
49 #define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
50 #define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
51 #define SSH_CHANNEL_LARVAL 10 /* larval session */
52 #define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
53 #define SSH_CHANNEL_CONNECTING 12
54 #define SSH_CHANNEL_DYNAMIC 13
55 #define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
56 #define SSH_CHANNEL_MUX_LISTENER 15 /* Listener for mux conn. */
57 #define SSH_CHANNEL_MUX_CLIENT 16 /* Conn. to mux slave */
58 #define SSH_CHANNEL_MAX_TYPE 17
61 typedef struct Channel Channel;
63 typedef void channel_open_fn(int, int, void *);
64 typedef void channel_callback_fn(int, void *);
65 typedef int channel_infilter_fn(struct Channel *, char *, int);
66 typedef void channel_filter_cleanup_fn(int, void *);
67 typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
69 /* Channel success/failure callbacks */
70 typedef void channel_confirm_cb(int, struct Channel *, void *);
71 typedef void channel_confirm_abandon_cb(struct Channel *, void *);
72 struct channel_confirm {
73 TAILQ_ENTRY(channel_confirm) entry;
74 channel_confirm_cb *cb;
75 channel_confirm_abandon_cb *abandon_cb;
78 TAILQ_HEAD(channel_confirms, channel_confirm);
80 /* Context for non-blocking connects */
81 struct channel_connect {
84 struct addrinfo *ai, *aitop;
87 /* Callbacks for mux channels back into client-specific code */
88 typedef int mux_callback_fn(struct Channel *);
91 int type; /* channel type/state */
92 int self; /* my own channel identifier */
93 int remote_id; /* channel identifier for remote peer */
94 u_int istate; /* input from channel (state of receive half) */
95 u_int ostate; /* output to channel (state of transmit half) */
96 int flags; /* close sent/rcvd */
97 int rfd; /* read fd */
98 int wfd; /* write fd */
99 int efd; /* extended fd */
100 int sock; /* sock fd */
101 int ctl_chan; /* control channel (multiplexed connections) */
102 int isatty; /* rfd is a tty */
103 int wfd_isatty; /* wfd is a tty */
104 int client_tty; /* (client) TTY has been requested */
105 int force_drain; /* force close on iEOF */
106 int delayed; /* post-select handlers for newly created
107 * channels are delayed until the first call
108 * to a matching pre-select handler.
109 * this way post-select handlers are not
110 * accidenly called if a FD gets reused */
111 Buffer input; /* data read from socket, to be sent over
112 * encrypted connection */
113 Buffer output; /* data received over encrypted connection for
117 /* path for unix domain sockets, or host name for forwards */
118 int listening_port; /* port being listened for forwards */
119 int host_port; /* remote port to connect for forwards */
120 char *remote_name; /* remote hostname */
123 u_int remote_maxpacket;
125 u_int local_window_max;
126 u_int local_consumed;
127 u_int local_maxpacket;
130 int single_connection;
133 char *ctype; /* type */
136 channel_open_fn *open_confirm;
137 void *open_confirm_ctx;
138 channel_callback_fn *detach_user;
140 struct channel_confirms status_confirms;
143 channel_infilter_fn *input_filter;
144 channel_outfilter_fn *output_filter;
146 channel_filter_cleanup_fn *filter_cleanup;
148 /* keep boundaries */
151 /* non-blocking connect */
152 struct channel_connect connect_ctx;
154 /* multiplexing protocol hook, called for each packet received */
155 mux_callback_fn *mux_rcb;
160 #define CHAN_EXTENDED_IGNORE 0
161 #define CHAN_EXTENDED_READ 1
162 #define CHAN_EXTENDED_WRITE 2
164 /* default window/packet sizes for tcp/x11-fwd-channel */
165 #define CHAN_SES_PACKET_DEFAULT (32*1024)
166 #define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
168 #define CHAN_TCP_PACKET_DEFAULT (32*1024)
169 #define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
171 #define CHAN_X11_PACKET_DEFAULT (16*1024)
172 #define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
174 /* possible input states */
175 #define CHAN_INPUT_OPEN 0
176 #define CHAN_INPUT_WAIT_DRAIN 1
177 #define CHAN_INPUT_WAIT_OCLOSE 2
178 #define CHAN_INPUT_CLOSED 3
180 /* possible output states */
181 #define CHAN_OUTPUT_OPEN 0
182 #define CHAN_OUTPUT_WAIT_DRAIN 1
183 #define CHAN_OUTPUT_WAIT_IEOF 2
184 #define CHAN_OUTPUT_CLOSED 3
186 #define CHAN_CLOSE_SENT 0x01
187 #define CHAN_CLOSE_RCVD 0x02
188 #define CHAN_EOF_SENT 0x04
189 #define CHAN_EOF_RCVD 0x08
190 #define CHAN_LOCAL 0x10
192 #define CHAN_RBUF 16*1024
194 /* check whether 'efd' is still in use */
195 #define CHANNEL_EFD_INPUT_ACTIVE(c) \
196 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
198 buffer_len(&c->extended) > 0))
199 #define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
200 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
201 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
202 buffer_len(&c->extended) > 0))
204 /* channel management */
206 Channel *channel_by_id(int);
207 Channel *channel_lookup(int);
208 Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
209 void channel_set_fds(int, int, int, int, int, int, int, u_int);
210 void channel_free(Channel *);
211 void channel_free_all(void);
212 void channel_stop_listening(void);
214 void channel_send_open(int);
215 void channel_request_start(int, char *, int);
216 void channel_register_cleanup(int, channel_callback_fn *, int);
217 void channel_register_open_confirm(int, channel_open_fn *, void *);
218 void channel_register_filter(int, channel_infilter_fn *,
219 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *);
220 void channel_register_status_confirm(int, channel_confirm_cb *,
221 channel_confirm_abandon_cb *, void *);
222 void channel_cancel_cleanup(int);
223 int channel_close_fd(int *);
224 void channel_send_window_changes(void);
226 /* protocol handler */
228 void channel_input_close(int, u_int32_t, void *);
229 void channel_input_close_confirmation(int, u_int32_t, void *);
230 void channel_input_data(int, u_int32_t, void *);
231 void channel_input_extended_data(int, u_int32_t, void *);
232 void channel_input_ieof(int, u_int32_t, void *);
233 void channel_input_oclose(int, u_int32_t, void *);
234 void channel_input_open_confirmation(int, u_int32_t, void *);
235 void channel_input_open_failure(int, u_int32_t, void *);
236 void channel_input_port_open(int, u_int32_t, void *);
237 void channel_input_window_adjust(int, u_int32_t, void *);
238 void channel_input_status_confirm(int, u_int32_t, void *);
240 /* file descriptor handling (read/write) */
242 void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
243 void channel_after_select(fd_set *, fd_set *);
244 int channel_output_poll(void);
246 int channel_not_very_much_buffered_data(void);
247 void channel_close_all(void);
248 int channel_still_open(void);
249 char *channel_open_message(void);
250 int channel_find_open(void);
253 void channel_set_af(int af);
254 void channel_permit_all_opens(void);
255 void channel_add_permitted_opens(char *, int);
256 int channel_add_adm_permitted_opens(char *, int);
257 void channel_clear_permitted_opens(void);
258 void channel_clear_adm_permitted_opens(void);
259 void channel_print_adm_permitted_opens(void);
260 int channel_input_port_forward_request(int, int);
261 Channel *channel_connect_to(const char *, u_short, char *, char *);
262 Channel *channel_connect_stdio_fwd(const char*, u_short, int, int);
263 Channel *channel_connect_by_listen_address(u_short, char *, char *);
264 int channel_request_remote_forwarding(const char *, u_short,
265 const char *, u_short);
266 int channel_setup_local_fwd_listener(const char *, u_short,
267 const char *, u_short, int);
268 void channel_request_rforward_cancel(const char *host, u_short port);
269 int channel_setup_remote_fwd_listener(const char *, u_short, int *, int);
270 int channel_cancel_rport_listener(const char *, u_short);
274 int x11_connect_display(void);
275 int x11_create_display_inet(int, int, int, u_int *, int **);
276 void x11_input_open(int, u_int32_t, void *);
277 void x11_request_forwarding_with_spoofing(int, const char *, const char *,
279 void deny_input_open(int, u_int32_t, void *);
281 /* agent forwarding */
283 void auth_request_forwarding(void);
287 int chan_is_dead(Channel *, int);
288 void chan_mark_dead(Channel *);
292 void chan_rcvd_oclose(Channel *);
293 void chan_rcvd_eow(Channel *); /* SSH2-only */
294 void chan_read_failed(Channel *);
295 void chan_ibuf_empty(Channel *);
297 void chan_rcvd_ieof(Channel *);
298 void chan_write_failed(Channel *);
299 void chan_obuf_empty(Channel *);
302 void channel_set_hpn(int, int);