]> andersk Git - openssh.git/blame - channels.h
- djm@cvs.openbsd.org 2010/01/30 02:54:53
[openssh.git] / channels.h
CommitLineData
a858eae9 1/* $OpenBSD: channels.h,v 1.103 2010/01/26 01:28:35 djm Exp $ */
93c3b6de 2
bcbf86ec 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/*
8ab5f6b2 15 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
bcbf86ec 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 */
8efc0c15 37
8e7895b8 38#ifndef CHANNEL_H
39#define CHANNEL_H
8efc0c15 40
41/* Definitions for channel types. */
aa3378df 42#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
5260325f 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 */
aa3378df 46#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
7368a6c8 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 */
fa08c86b 52#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
97fb6912 53#define SSH_CHANNEL_CONNECTING 12
0490e609 54#define SSH_CHANNEL_DYNAMIC 13
6fd8622b 55#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
a858eae9 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
8efc0c15 59
2e73a022 60struct Channel;
61typedef struct Channel Channel;
62
2a1e4639 63typedef void channel_callback_fn(int, void *);
c1c6a032 64typedef int channel_infilter_fn(struct Channel *, char *, int);
e74caf1e 65typedef void channel_filter_cleanup_fn(int, void *);
c1c6a032 66typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
8efc0c15 67
3593bdc0 68/* Channel success/failure callbacks */
69typedef void channel_confirm_cb(int, struct Channel *, void *);
70typedef void channel_confirm_abandon_cb(struct Channel *, void *);
71struct channel_confirm {
72 TAILQ_ENTRY(channel_confirm) entry;
73 channel_confirm_cb *cb;
74 channel_confirm_abandon_cb *abandon_cb;
75 void *ctx;
76};
77TAILQ_HEAD(channel_confirms, channel_confirm);
78
e07e21ad 79/* Context for non-blocking connects */
80struct channel_connect {
81 char *host;
82 int port;
83 struct addrinfo *ai, *aitop;
84};
85
a858eae9 86/* Callbacks for mux channels back into client-specific code */
87typedef int mux_callback_fn(struct Channel *);
88
2e73a022 89struct Channel {
5260325f 90 int type; /* channel type/state */
91 int self; /* my own channel identifier */
92 int remote_id; /* channel identifier for remote peer */
368e9dfc 93 u_int istate; /* input from channel (state of receive half) */
94 u_int ostate; /* output to channel (state of transmit half) */
7e7327a1 95 int flags; /* close sent/rcvd */
7368a6c8 96 int rfd; /* read fd */
97 int wfd; /* write fd */
98 int efd; /* extended fd */
99 int sock; /* sock fd */
a858eae9 100 int ctl_chan; /* control channel (multiplexed connections) */
0ae4fe1d 101 int isatty; /* rfd is a tty */
21c2c5cd 102 int wfd_isatty; /* wfd is a tty */
2c9a4d41 103 int client_tty; /* (client) TTY has been requested */
639cb8ab 104 int force_drain; /* force close on iEOF */
7501ed0d 105 int delayed; /* post-select handlers for newly created
106 * channels are delayed until the first call
107 * to a matching pre-select handler.
108 * this way post-select handlers are not
109 * accidenly called if a FD gets reused */
5260325f 110 Buffer input; /* data read from socket, to be sent over
111 * encrypted connection */
112 Buffer output; /* data received over encrypted connection for
113 * send on socket */
7368a6c8 114 Buffer extended;
1338ba77 115 char *path;
719fc62f 116 /* path for unix domain sockets, or host name for forwards */
5260325f 117 int listening_port; /* port being listened for forwards */
118 int host_port; /* remote port to connect for forwards */
119 char *remote_name; /* remote hostname */
7368a6c8 120
f91d9a89 121 u_int remote_window;
122 u_int remote_maxpacket;
123 u_int local_window;
124 u_int local_window_max;
125 u_int local_consumed;
126 u_int local_maxpacket;
7368a6c8 127 int extended_usage;
ac151b18 128 int single_connection;
7368a6c8 129
130 char *ctype; /* type */
131
1d1ffb87 132 /* callback */
3593bdc0 133 channel_callback_fn *open_confirm;
134 void *open_confirm_ctx;
8cd0437d 135 channel_callback_fn *detach_user;
136 int detach_close;
3593bdc0 137 struct channel_confirms status_confirms;
2e73a022 138
139 /* filter */
c1c6a032 140 channel_infilter_fn *input_filter;
141 channel_outfilter_fn *output_filter;
f17f705b 142 void *filter_ctx;
e74caf1e 143 channel_filter_cleanup_fn *filter_cleanup;
d20f3c9e 144
e07e21ad 145 /* keep boundaries */
146 int datagram;
147
148 /* non-blocking connect */
149 struct channel_connect connect_ctx;
a858eae9 150
151 /* multiplexing protocol hook, called for each packet received */
152 mux_callback_fn *mux_rcb;
153 void *mux_ctx;
2e73a022 154};
7368a6c8 155
156#define CHAN_EXTENDED_IGNORE 0
157#define CHAN_EXTENDED_READ 1
158#define CHAN_EXTENDED_WRITE 2
159
bcbf86ec 160/* default window/packet sizes for tcp/x11-fwd-channel */
ea9700ba 161#define CHAN_SES_PACKET_DEFAULT (32*1024)
e110afc3 162#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT)
ea9700ba 163#define CHAN_TCP_PACKET_DEFAULT (32*1024)
e110afc3 164#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT)
ea9700ba 165#define CHAN_X11_PACKET_DEFAULT (16*1024)
166#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
bcbf86ec 167
8e7895b8 168/* possible input states */
368e9dfc 169#define CHAN_INPUT_OPEN 0
170#define CHAN_INPUT_WAIT_DRAIN 1
171#define CHAN_INPUT_WAIT_OCLOSE 2
172#define CHAN_INPUT_CLOSED 3
bcbf86ec 173
8e7895b8 174/* possible output states */
368e9dfc 175#define CHAN_OUTPUT_OPEN 0
176#define CHAN_OUTPUT_WAIT_DRAIN 1
177#define CHAN_OUTPUT_WAIT_IEOF 2
178#define CHAN_OUTPUT_CLOSED 3
8e7895b8 179
180#define CHAN_CLOSE_SENT 0x01
181#define CHAN_CLOSE_RCVD 0x02
d2296ed7 182#define CHAN_EOF_SENT 0x04
183#define CHAN_EOF_RCVD 0x08
a858eae9 184#define CHAN_LOCAL 0x10
d2296ed7 185
c1c6a032 186#define CHAN_RBUF 16*1024
187
d2296ed7 188/* check whether 'efd' is still in use */
189#define CHANNEL_EFD_INPUT_ACTIVE(c) \
190 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
191 (c->efd != -1 || \
192 buffer_len(&c->extended) > 0))
193#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
194 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
cee6ad3d 195 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
d2296ed7 196 buffer_len(&c->extended) > 0))
8e7895b8 197
8e7895b8 198/* channel management */
199
b872f7f0 200Channel *channel_by_id(int);
2a1e4639 201Channel *channel_lookup(int);
f91d9a89 202Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
c9478090 203void channel_set_fds(int, int, int, int, int, int, int, u_int);
3cf2be58 204void channel_free(Channel *);
205void channel_free_all(void);
3cf2be58 206void channel_stop_listening(void);
255cabd9 207
208void channel_send_open(int);
255cabd9 209void channel_request_start(int, char *, int);
8cd0437d 210void channel_register_cleanup(int, channel_callback_fn *, int);
3593bdc0 211void channel_register_open_confirm(int, channel_callback_fn *, void *);
212void channel_register_filter(int, channel_infilter_fn *,
e74caf1e 213 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *);
3593bdc0 214void channel_register_status_confirm(int, channel_confirm_cb *,
215 channel_confirm_abandon_cb *, void *);
255cabd9 216void channel_cancel_cleanup(int);
489aa2e9 217int channel_close_fd(int *);
5e96b616 218void channel_send_window_changes(void);
7368a6c8 219
8e7895b8 220/* protocol handler */
7368a6c8 221
7819b5c3 222void channel_input_close(int, u_int32_t, void *);
223void channel_input_close_confirmation(int, u_int32_t, void *);
224void channel_input_data(int, u_int32_t, void *);
225void channel_input_extended_data(int, u_int32_t, void *);
226void channel_input_ieof(int, u_int32_t, void *);
227void channel_input_oclose(int, u_int32_t, void *);
228void channel_input_open_confirmation(int, u_int32_t, void *);
229void channel_input_open_failure(int, u_int32_t, void *);
230void channel_input_port_open(int, u_int32_t, void *);
231void channel_input_window_adjust(int, u_int32_t, void *);
3593bdc0 232void channel_input_status_confirm(int, u_int32_t, void *);
7368a6c8 233
8e7895b8 234/* file descriptor handling (read/write) */
7368a6c8 235
9a995072 236void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
255cabd9 237void channel_after_select(fd_set *, fd_set *);
238void channel_output_poll(void);
7368a6c8 239
255cabd9 240int channel_not_very_much_buffered_data(void);
241void channel_close_all(void);
255cabd9 242int channel_still_open(void);
243char *channel_open_message(void);
244int channel_find_open(void);
7368a6c8 245
5e4a7219 246/* tcp forwarding */
247void channel_set_af(int af);
255cabd9 248void channel_permit_all_opens(void);
249void channel_add_permitted_opens(char *, int);
ea46e550 250int channel_add_adm_permitted_opens(char *, int);
255cabd9 251void channel_clear_permitted_opens(void);
2fefbadf 252void channel_clear_adm_permitted_opens(void);
1760c982 253void channel_print_adm_permitted_opens(void);
42ea6f5e 254int channel_input_port_forward_request(int, int);
e07e21ad 255Channel *channel_connect_to(const char *, u_short, char *, char *);
a858eae9 256Channel *channel_connect_stdio_fwd(const char*, u_short, int, int);
e07e21ad 257Channel *channel_connect_by_listen_address(u_short, char *, char *);
42ea6f5e 258int channel_request_remote_forwarding(const char *, u_short,
3867aa0a 259 const char *, u_short);
260int channel_setup_local_fwd_listener(const char *, u_short,
261 const char *, u_short, int);
262void channel_request_rforward_cancel(const char *host, u_short port);
17525a70 263int channel_setup_remote_fwd_listener(const char *, u_short, int *, int);
d740ec16 264int channel_cancel_rport_listener(const char *, u_short);
7368a6c8 265
8e7895b8 266/* x11 forwarding */
7368a6c8 267
255cabd9 268int x11_connect_display(void);
d08341e6 269int x11_create_display_inet(int, int, int, u_int *, int **);
7819b5c3 270void x11_input_open(int, u_int32_t, void *);
9bf083eb 271void x11_request_forwarding_with_spoofing(int, const char *, const char *,
e07e21ad 272 const char *);
7819b5c3 273void deny_input_open(int, u_int32_t, void *);
7368a6c8 274
8e7895b8 275/* agent forwarding */
7368a6c8 276
255cabd9 277void auth_request_forwarding(void);
7368a6c8 278
8e7895b8 279/* channel close */
7e7327a1 280
418e724c 281int chan_is_dead(Channel *, int);
255cabd9 282void chan_mark_dead(Channel *);
255cabd9 283
70bef40e 284/* channel events */
8e7895b8 285
70bef40e 286void chan_rcvd_oclose(Channel *);
50c96367 287void chan_rcvd_eow(Channel *); /* SSH2-only */
70bef40e 288void chan_read_failed(Channel *);
289void chan_ibuf_empty(Channel *);
8e7895b8 290
70bef40e 291void chan_rcvd_ieof(Channel *);
292void chan_write_failed(Channel *);
293void chan_obuf_empty(Channel *);
8e7895b8 294
8efc0c15 295#endif
This page took 0.263381 seconds and 5 git commands to generate.