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