1 /* $OpenBSD: channels.h,v 1.70 2002/06/24 14:33:27 markus Exp $ */
2 /* $FreeBSD: src/crypto/openssh/channels.h,v 1.1.1.1.2.7 2003/02/03 17:31:06 des Exp $ */
3 /* $DragonFly: src/crypto/openssh/Attic/channels.h,v 1.2 2003/06/17 04:24:36 dillon Exp $ */
6 * Author: Tatu Ylonen <ylo@cs.hut.fi>
7 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
10 * As far as I am concerned, the code I have written for this software
11 * can be used freely for any purpose. Any derived versions of this
12 * software must be clearly marked as such, and if the derived work is
13 * incompatible with the protocol description in the RFC file, it must be
14 * called by a name other than "ssh" or "Secure Shell".
17 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
28 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
33 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
37 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 /* Definitions for channel types. */
46 #define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
47 #define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
48 #define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
49 #define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
50 #define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
51 #define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
52 #define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
53 #define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
54 #define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
55 #define SSH_CHANNEL_LARVAL 10 /* larval session */
56 #define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
57 #define SSH_CHANNEL_CONNECTING 12
58 #define SSH_CHANNEL_DYNAMIC 13
59 #define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
60 #define SSH_CHANNEL_MAX_TYPE 15
62 #define SSH_CHANNEL_PATH_LEN 256
65 typedef struct Channel Channel;
67 typedef void channel_callback_fn(int, void *);
68 typedef int channel_filter_fn(struct Channel *, char *, int);
71 int type; /* channel type/state */
72 int self; /* my own channel identifier */
73 int remote_id; /* channel identifier for remote peer */
74 u_int istate; /* input from channel (state of receive half) */
75 u_int ostate; /* output to channel (state of transmit half) */
76 int flags; /* close sent/rcvd */
77 int rfd; /* read fd */
78 int wfd; /* write fd */
79 int efd; /* extended fd */
80 int sock; /* sock fd */
81 int isatty; /* rfd is a tty */
82 int wfd_isatty; /* wfd is a tty */
83 int force_drain; /* force close on iEOF */
84 int delayed; /* fdset hack */
85 Buffer input; /* data read from socket, to be sent over
86 * encrypted connection */
87 Buffer output; /* data received over encrypted connection for
90 char path[SSH_CHANNEL_PATH_LEN];
91 /* path for unix domain sockets, or host name for forwards */
92 int listening_port; /* port being listened for forwards */
93 int host_port; /* remote port to connect for forwards */
94 char *remote_name; /* remote hostname */
97 u_int remote_maxpacket;
99 u_int local_window_max;
100 u_int local_consumed;
101 u_int local_maxpacket;
103 int single_connection;
105 char *ctype; /* type */
108 channel_callback_fn *confirm;
109 channel_callback_fn *detach_user;
112 channel_filter_fn *input_filter;
115 #define CHAN_EXTENDED_IGNORE 0
116 #define CHAN_EXTENDED_READ 1
117 #define CHAN_EXTENDED_WRITE 2
119 /* default window/packet sizes for tcp/x11-fwd-channel */
120 #define CHAN_SES_PACKET_DEFAULT (32*1024)
121 #define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
122 #define CHAN_TCP_PACKET_DEFAULT (32*1024)
123 #define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
124 #define CHAN_X11_PACKET_DEFAULT (16*1024)
125 #define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
127 /* possible input states */
128 #define CHAN_INPUT_OPEN 0
129 #define CHAN_INPUT_WAIT_DRAIN 1
130 #define CHAN_INPUT_WAIT_OCLOSE 2
131 #define CHAN_INPUT_CLOSED 3
133 /* possible output states */
134 #define CHAN_OUTPUT_OPEN 0
135 #define CHAN_OUTPUT_WAIT_DRAIN 1
136 #define CHAN_OUTPUT_WAIT_IEOF 2
137 #define CHAN_OUTPUT_CLOSED 3
139 #define CHAN_CLOSE_SENT 0x01
140 #define CHAN_CLOSE_RCVD 0x02
141 #define CHAN_EOF_SENT 0x04
142 #define CHAN_EOF_RCVD 0x08
144 /* check whether 'efd' is still in use */
145 #define CHANNEL_EFD_INPUT_ACTIVE(c) \
146 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
148 buffer_len(&c->extended) > 0))
149 #define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
150 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
151 ((c->efd != -1 && !(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD))) || \
152 buffer_len(&c->extended) > 0))
154 /* channel management */
156 Channel *channel_lookup(int);
157 Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
158 void channel_set_fds(int, int, int, int, int, int, u_int);
159 void channel_free(Channel *);
160 void channel_free_all(void);
161 void channel_stop_listening(void);
163 void channel_send_open(int);
164 void channel_request_start(int, char *, int);
165 void channel_register_cleanup(int, channel_callback_fn *);
166 void channel_register_confirm(int, channel_callback_fn *);
167 void channel_register_filter(int, channel_filter_fn *);
168 void channel_cancel_cleanup(int);
169 int channel_close_fd(int *);
171 /* protocol handler */
173 void channel_input_close(int, u_int32_t, void *);
174 void channel_input_close_confirmation(int, u_int32_t, void *);
175 void channel_input_data(int, u_int32_t, void *);
176 void channel_input_extended_data(int, u_int32_t, void *);
177 void channel_input_ieof(int, u_int32_t, void *);
178 void channel_input_oclose(int, u_int32_t, void *);
179 void channel_input_open_confirmation(int, u_int32_t, void *);
180 void channel_input_open_failure(int, u_int32_t, void *);
181 void channel_input_port_open(int, u_int32_t, void *);
182 void channel_input_window_adjust(int, u_int32_t, void *);
184 /* file descriptor handling (read/write) */
186 void channel_prepare_select(fd_set **, fd_set **, int *, int*, int);
187 void channel_after_select(fd_set *, fd_set *);
188 void channel_output_poll(void);
190 int channel_not_very_much_buffered_data(void);
191 void channel_close_all(void);
192 int channel_still_open(void);
193 char *channel_open_message(void);
194 int channel_find_open(void);
197 void channel_set_af(int af);
198 void channel_permit_all_opens(void);
199 void channel_add_permitted_opens(char *, int);
200 void channel_clear_permitted_opens(void);
201 void channel_input_port_forward_request(int, int);
202 int channel_connect_to(const char *, u_short);
203 int channel_connect_by_listen_address(u_short);
204 void channel_request_remote_forwarding(u_short, const char *, u_short);
205 int channel_setup_local_fwd_listener(u_short, const char *, u_short, int);
206 int channel_setup_remote_fwd_listener(const char *, u_short, int);
210 int x11_connect_display(void);
211 int x11_create_display_inet(int, int, int, u_int *);
212 void x11_input_open(int, u_int32_t, void *);
213 void x11_request_forwarding_with_spoofing(int, const char *, const char *);
214 void deny_input_open(int, u_int32_t, void *);
216 /* agent forwarding */
218 void auth_request_forwarding(void);
219 void auth_input_open_request(int, u_int32_t, void *);
223 int chan_is_dead(Channel *, int);
224 void chan_mark_dead(Channel *);
228 void chan_rcvd_oclose(Channel *);
229 void chan_read_failed(Channel *);
230 void chan_ibuf_empty(Channel *);
232 void chan_rcvd_ieof(Channel *);
233 void chan_write_failed(Channel *);
234 void chan_obuf_empty(Channel *);