]>
Commit | Line | Data |
---|---|---|
2e437378 | 1 | /* $OpenBSD: channels.h,v 1.88 2006/08/03 03:34:42 deraadt Exp $ */ |
e9a17296 | 2 | |
3c0ef626 | 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 | /* | |
e9a17296 | 15 | * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved. |
3c0ef626 | 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 | */ | |
3c0ef626 | 37 | |
38 | #ifndef CHANNEL_H | |
39 | #define CHANNEL_H | |
40 | ||
3c0ef626 | 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_MAX_TYPE 15 | |
57 | ||
58 | #define SSH_CHANNEL_PATH_LEN 256 | |
59 | ||
60 | struct Channel; | |
61 | typedef struct Channel Channel; | |
62 | ||
63 | typedef void channel_callback_fn(int, void *); | |
e00da40d | 64 | typedef int channel_infilter_fn(struct Channel *, char *, int); |
65 | typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *); | |
3c0ef626 | 66 | |
67 | struct Channel { | |
68 | int type; /* channel type/state */ | |
69 | int self; /* my own channel identifier */ | |
70 | int remote_id; /* channel identifier for remote peer */ | |
e9a17296 | 71 | u_int istate; /* input from channel (state of receive half) */ |
72 | u_int ostate; /* output to channel (state of transmit half) */ | |
3c0ef626 | 73 | int flags; /* close sent/rcvd */ |
74 | int rfd; /* read fd */ | |
75 | int wfd; /* write fd */ | |
76 | int efd; /* extended fd */ | |
77 | int sock; /* sock fd */ | |
1b56ff3d | 78 | int ctl_fd; /* control fd (client sharing) */ |
3c0ef626 | 79 | int isatty; /* rfd is a tty */ |
e54b3d7c | 80 | int wfd_isatty; /* wfd is a tty */ |
34fee935 | 81 | int client_tty; /* (client) TTY has been requested */ |
3c0ef626 | 82 | int force_drain; /* force close on iEOF */ |
83 | int delayed; /* fdset hack */ | |
84 | Buffer input; /* data read from socket, to be sent over | |
85 | * encrypted connection */ | |
86 | Buffer output; /* data received over encrypted connection for | |
87 | * send on socket */ | |
88 | Buffer extended; | |
89 | char path[SSH_CHANNEL_PATH_LEN]; | |
90 | /* path for unix domain sockets, or host name for forwards */ | |
91 | int listening_port; /* port being listened for forwards */ | |
92 | int host_port; /* remote port to connect for forwards */ | |
93 | char *remote_name; /* remote hostname */ | |
94 | ||
ff2d7a98 | 95 | u_int remote_window; |
96 | u_int remote_maxpacket; | |
97 | u_int local_window; | |
98 | u_int local_window_max; | |
99 | u_int local_consumed; | |
100 | u_int local_maxpacket; | |
34fee935 | 101 | int dynamic_window; |
3c0ef626 | 102 | int extended_usage; |
e9a17296 | 103 | int single_connection; |
e00da40d | 104 | u_int tcpwinsz; |
3c0ef626 | 105 | |
106 | char *ctype; /* type */ | |
107 | ||
108 | /* callback */ | |
e9a17296 | 109 | channel_callback_fn *confirm; |
1b56ff3d | 110 | void *confirm_ctx; |
e00da40d | 111 | channel_callback_fn *detach_user; |
112 | int detach_close; | |
3c0ef626 | 113 | |
114 | /* filter */ | |
e00da40d | 115 | channel_infilter_fn *input_filter; |
116 | channel_outfilter_fn *output_filter; | |
117 | ||
118 | int datagram; /* keep boundaries */ | |
3c0ef626 | 119 | }; |
120 | ||
121 | #define CHAN_EXTENDED_IGNORE 0 | |
122 | #define CHAN_EXTENDED_READ 1 | |
123 | #define CHAN_EXTENDED_WRITE 2 | |
124 | ||
125 | /* default window/packet sizes for tcp/x11-fwd-channel */ | |
e00da40d | 126 | #define CHAN_SES_PACKET_DEFAULT (32*1024) |
127 | #define CHAN_SES_WINDOW_DEFAULT_HPN (160*CHAN_TCP_PACKET_DEFAULT) | |
128 | #define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT) | |
129 | ||
130 | #define CHAN_TCP_PACKET_DEFAULT (32*1024) | |
131 | #define CHAN_TCP_WINDOW_DEFAULT_HPN (160*CHAN_TCP_PACKET_DEFAULT) | |
132 | #define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT) | |
133 | ||
134 | #define CHAN_X11_PACKET_DEFAULT (16*1024) | |
135 | #define CHAN_X11_WINDOW_DEFAULT_HPN (4*CHAN_X11_PACKET_DEFAULT) | |
136 | #define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) | |
3c0ef626 | 137 | |
138 | /* possible input states */ | |
e9a17296 | 139 | #define CHAN_INPUT_OPEN 0 |
140 | #define CHAN_INPUT_WAIT_DRAIN 1 | |
141 | #define CHAN_INPUT_WAIT_OCLOSE 2 | |
142 | #define CHAN_INPUT_CLOSED 3 | |
3c0ef626 | 143 | |
144 | /* possible output states */ | |
e9a17296 | 145 | #define CHAN_OUTPUT_OPEN 0 |
146 | #define CHAN_OUTPUT_WAIT_DRAIN 1 | |
147 | #define CHAN_OUTPUT_WAIT_IEOF 2 | |
148 | #define CHAN_OUTPUT_CLOSED 3 | |
3c0ef626 | 149 | |
150 | #define CHAN_CLOSE_SENT 0x01 | |
151 | #define CHAN_CLOSE_RCVD 0x02 | |
2980ea68 | 152 | #define CHAN_EOF_SENT 0x04 |
153 | #define CHAN_EOF_RCVD 0x08 | |
154 | ||
e00da40d | 155 | #define CHAN_RBUF 16*1024 |
156 | ||
2980ea68 | 157 | /* check whether 'efd' is still in use */ |
158 | #define CHANNEL_EFD_INPUT_ACTIVE(c) \ | |
159 | (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ | |
160 | (c->efd != -1 || \ | |
161 | buffer_len(&c->extended) > 0)) | |
162 | #define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ | |
163 | (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ | |
34fee935 | 164 | c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \ |
2980ea68 | 165 | buffer_len(&c->extended) > 0)) |
3c0ef626 | 166 | |
167 | /* channel management */ | |
168 | ||
e00da40d | 169 | Channel *channel_by_id(int); |
3c0ef626 | 170 | Channel *channel_lookup(int); |
ff2d7a98 | 171 | Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int); |
e9a17296 | 172 | void channel_set_fds(int, int, int, int, int, int, u_int); |
3c0ef626 | 173 | void channel_free(Channel *); |
174 | void channel_free_all(void); | |
175 | void channel_stop_listening(void); | |
176 | ||
177 | void channel_send_open(int); | |
3c0ef626 | 178 | void channel_request_start(int, char *, int); |
e00da40d | 179 | void channel_register_cleanup(int, channel_callback_fn *, int); |
1b56ff3d | 180 | void channel_register_confirm(int, channel_callback_fn *, void *); |
e00da40d | 181 | void channel_register_filter(int, channel_infilter_fn *, channel_outfilter_fn *); |
3c0ef626 | 182 | void channel_cancel_cleanup(int); |
183 | int channel_close_fd(int *); | |
1b56ff3d | 184 | void channel_send_window_changes(void); |
3c0ef626 | 185 | |
186 | /* protocol handler */ | |
187 | ||
e9a17296 | 188 | void channel_input_close(int, u_int32_t, void *); |
189 | void channel_input_close_confirmation(int, u_int32_t, void *); | |
190 | void channel_input_data(int, u_int32_t, void *); | |
191 | void channel_input_extended_data(int, u_int32_t, void *); | |
192 | void channel_input_ieof(int, u_int32_t, void *); | |
193 | void channel_input_oclose(int, u_int32_t, void *); | |
194 | void channel_input_open_confirmation(int, u_int32_t, void *); | |
195 | void channel_input_open_failure(int, u_int32_t, void *); | |
196 | void channel_input_port_open(int, u_int32_t, void *); | |
197 | void channel_input_window_adjust(int, u_int32_t, void *); | |
3c0ef626 | 198 | |
199 | /* file descriptor handling (read/write) */ | |
200 | ||
1b56ff3d | 201 | void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int); |
3c0ef626 | 202 | void channel_after_select(fd_set *, fd_set *); |
203 | void channel_output_poll(void); | |
204 | ||
205 | int channel_not_very_much_buffered_data(void); | |
206 | void channel_close_all(void); | |
207 | int channel_still_open(void); | |
208 | char *channel_open_message(void); | |
209 | int channel_find_open(void); | |
210 | ||
211 | /* tcp forwarding */ | |
212 | void channel_set_af(int af); | |
213 | void channel_permit_all_opens(void); | |
214 | void channel_add_permitted_opens(char *, int); | |
2e437378 | 215 | int channel_add_adm_permitted_opens(char *, int); |
3c0ef626 | 216 | void channel_clear_permitted_opens(void); |
2e437378 | 217 | void channel_clear_adm_permitted_opens(void); |
218 | int channel_input_port_forward_request(int, int, int, int); | |
3c0ef626 | 219 | int channel_connect_to(const char *, u_short); |
220 | int channel_connect_by_listen_address(u_short); | |
2e437378 | 221 | int channel_request_remote_forwarding(const char *, u_short, |
34fee935 | 222 | const char *, u_short); |
223 | int channel_setup_local_fwd_listener(const char *, u_short, | |
e00da40d | 224 | const char *, u_short, int, int, int); |
34fee935 | 225 | void channel_request_rforward_cancel(const char *host, u_short port); |
e00da40d | 226 | int channel_setup_remote_fwd_listener(const char *, u_short, int, int, int); |
1b56ff3d | 227 | int channel_cancel_rport_listener(const char *, u_short); |
3c0ef626 | 228 | |
229 | /* x11 forwarding */ | |
230 | ||
231 | int x11_connect_display(void); | |
e00da40d | 232 | int x11_create_display_inet(int, int, int, u_int *, int **, int, int); |
e9a17296 | 233 | void x11_input_open(int, u_int32_t, void *); |
34fee935 | 234 | void x11_request_forwarding_with_spoofing(int, const char *, const char *, |
235 | const char *); | |
e9a17296 | 236 | void deny_input_open(int, u_int32_t, void *); |
3c0ef626 | 237 | |
238 | /* agent forwarding */ | |
239 | ||
240 | void auth_request_forwarding(void); | |
3c0ef626 | 241 | |
242 | /* channel close */ | |
243 | ||
244 | int chan_is_dead(Channel *, int); | |
245 | void chan_mark_dead(Channel *); | |
3c0ef626 | 246 | |
e9a17296 | 247 | /* channel events */ |
3c0ef626 | 248 | |
e9a17296 | 249 | void chan_rcvd_oclose(Channel *); |
250 | void chan_read_failed(Channel *); | |
251 | void chan_ibuf_empty(Channel *); | |
3c0ef626 | 252 | |
e9a17296 | 253 | void chan_rcvd_ieof(Channel *); |
254 | void chan_write_failed(Channel *); | |
255 | void chan_obuf_empty(Channel *); | |
3c0ef626 | 256 | |
257 | #endif |