1 /* $OpenBSD: channels.h,v 1.98 2009/02/12 03:00:56 djm Exp $ */ 2 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 /* 15 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved. 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 */ 37 38 #ifndef CHANNEL_H 39 #define CHANNEL_H 40 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 struct Channel; 59 typedef struct Channel Channel; 60 61 typedef void channel_callback_fn(int, void *); 62 typedef int channel_infilter_fn(struct Channel *, char *, int); 63 typedef void channel_filter_cleanup_fn(int, void *); 64 typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *); 65 66 /* Channel success/failure callbacks */ 67 typedef void channel_confirm_cb(int, struct Channel *, void *); 68 typedef void channel_confirm_abandon_cb(struct Channel *, void *); 69 struct channel_confirm { 70 TAILQ_ENTRY(channel_confirm) entry; 71 channel_confirm_cb *cb; 72 channel_confirm_abandon_cb *abandon_cb; 73 void *ctx; 74 }; 75 TAILQ_HEAD(channel_confirms, channel_confirm); 76 77 /* Context for non-blocking connects */ 78 struct channel_connect { 79 char *host; 80 int port; 81 struct addrinfo *ai, *aitop; 82 }; 83 84 struct Channel { 85 int type; /* channel type/state */ 86 int self; /* my own channel identifier */ 87 int remote_id; /* channel identifier for remote peer */ 88 u_int istate; /* input from channel (state of receive half) */ 89 u_int ostate; /* output to channel (state of transmit half) */ 90 int flags; /* close sent/rcvd */ 91 int rfd; /* read fd */ 92 int wfd; /* write fd */ 93 int efd; /* extended fd */ 94 int sock; /* sock fd */ 95 int ctl_fd; /* control fd (client sharing) */ 96 int isatty; /* rfd is a tty */ 97 int wfd_isatty; /* wfd is a tty */ 98 int client_tty; /* (client) TTY has been requested */ 99 int force_drain; /* force close on iEOF */ 100 int delayed; /* fdset hack */ 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 */ 105 Buffer extended; 106 char *path; 107 /* path for unix domain sockets, or host name for forwards */ 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 */ 111 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; 118 int dynamic_window; 119 int extended_usage; 120 int single_connection; 121 u_int tcpwinsz; 122 123 char *ctype; /* type */ 124 125 /* callback */ 126 channel_callback_fn *open_confirm; 127 void *open_confirm_ctx; 128 channel_callback_fn *detach_user; 129 int detach_close; 130 struct channel_confirms status_confirms; 131 132 /* filter */ 133 channel_infilter_fn *input_filter; 134 channel_outfilter_fn *output_filter; 135 void *filter_ctx; 136 channel_filter_cleanup_fn *filter_cleanup; 137 138 /* keep boundaries */ 139 int datagram; 140 141 /* non-blocking connect */ 142 struct channel_connect connect_ctx; 143 }; 144 145 #define CHAN_EXTENDED_IGNORE 0 146 #define CHAN_EXTENDED_READ 1 147 #define CHAN_EXTENDED_WRITE 2 148 149 /* default window/packet sizes for tcp/x11-fwd-channel */ 150 #define CHAN_SES_PACKET_DEFAULT (32*1024) 151 #define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT) 152 153 #define CHAN_TCP_PACKET_DEFAULT (32*1024) 154 #define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT) 155 156 #define CHAN_X11_PACKET_DEFAULT (16*1024) 157 #define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) 158 159 /* possible input states */ 160 #define CHAN_INPUT_OPEN 0 161 #define CHAN_INPUT_WAIT_DRAIN 1 162 #define CHAN_INPUT_WAIT_OCLOSE 2 163 #define CHAN_INPUT_CLOSED 3 164 165 /* possible output states */ 166 #define CHAN_OUTPUT_OPEN 0 167 #define CHAN_OUTPUT_WAIT_DRAIN 1 168 #define CHAN_OUTPUT_WAIT_IEOF 2 169 #define CHAN_OUTPUT_CLOSED 3 170 171 #define CHAN_CLOSE_SENT 0x01 172 #define CHAN_CLOSE_RCVD 0x02 173 #define CHAN_EOF_SENT 0x04 174 #define CHAN_EOF_RCVD 0x08 175 176 #define CHAN_RBUF 16*1024 177 178 /* check whether 'efd' is still in use */ 179 #define CHANNEL_EFD_INPUT_ACTIVE(c) \ 180 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ 181 (c->efd != -1 || \ 182 buffer_len(&c->extended) > 0)) 183 #define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ 184 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ 185 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \ 186 buffer_len(&c->extended) > 0)) 187 188 /* channel management */ 189 190 Channel *channel_by_id(int); 191 Channel *channel_lookup(int); 192 Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int); 193 void channel_set_fds(int, int, int, int, int, int, int, u_int); 194 void channel_free(Channel *); 195 void channel_free_all(void); 196 void channel_stop_listening(void); 197 198 void channel_send_open(int); 199 void channel_request_start(int, char *, int); 200 void channel_register_cleanup(int, channel_callback_fn *, int); 201 void channel_register_open_confirm(int, channel_callback_fn *, void *); 202 void channel_register_filter(int, channel_infilter_fn *, 203 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *); 204 void channel_register_status_confirm(int, channel_confirm_cb *, 205 channel_confirm_abandon_cb *, void *); 206 void channel_cancel_cleanup(int); 207 int channel_close_fd(int *); 208 void channel_send_window_changes(void); 209 210 /* protocol handler */ 211 212 void channel_input_close(int, u_int32_t, void *); 213 void channel_input_close_confirmation(int, u_int32_t, void *); 214 void channel_input_data(int, u_int32_t, void *); 215 void channel_input_extended_data(int, u_int32_t, void *); 216 void channel_input_ieof(int, u_int32_t, void *); 217 void channel_input_oclose(int, u_int32_t, void *); 218 void channel_input_open_confirmation(int, u_int32_t, void *); 219 void channel_input_open_failure(int, u_int32_t, void *); 220 void channel_input_port_open(int, u_int32_t, void *); 221 void channel_input_window_adjust(int, u_int32_t, void *); 222 void channel_input_status_confirm(int, u_int32_t, void *); 223 224 /* file descriptor handling (read/write) */ 225 226 void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int); 227 void channel_after_select(fd_set *, fd_set *); 228 int channel_output_poll(void); 229 230 int channel_not_very_much_buffered_data(void); 231 void channel_close_all(void); 232 int channel_still_open(void); 233 char *channel_open_message(void); 234 int channel_find_open(void); 235 236 /* tcp forwarding */ 237 void channel_set_af(int af); 238 void channel_permit_all_opens(void); 239 void channel_add_permitted_opens(char *, int); 240 int channel_add_adm_permitted_opens(char *, int); 241 void channel_clear_permitted_opens(void); 242 void channel_clear_adm_permitted_opens(void); 243 void channel_print_adm_permitted_opens(void); 244 int channel_input_port_forward_request(int, int); 245 Channel *channel_connect_to(const char *, u_short, char *, char *); 246 Channel *channel_connect_by_listen_address(u_short, char *, char *); 247 int channel_request_remote_forwarding(const char *, u_short, 248 const char *, u_short); 249 int channel_setup_local_fwd_listener(const char *, u_short, 250 const char *, u_short, int); 251 void channel_request_rforward_cancel(const char *host, u_short port); 252 int channel_setup_remote_fwd_listener(const char *, u_short, int *, int); 253 int channel_cancel_rport_listener(const char *, u_short); 254 255 /* x11 forwarding */ 256 257 int x11_connect_display(void); 258 int x11_create_display_inet(int, int, int, u_int *, int **); 259 void x11_input_open(int, u_int32_t, void *); 260 void x11_request_forwarding_with_spoofing(int, const char *, const char *, 261 const char *); 262 void deny_input_open(int, u_int32_t, void *); 263 264 /* agent forwarding */ 265 266 void auth_request_forwarding(void); 267 268 /* channel close */ 269 270 int chan_is_dead(Channel *, int); 271 void chan_mark_dead(Channel *); 272 273 /* channel events */ 274 275 void chan_rcvd_oclose(Channel *); 276 void chan_rcvd_eow(Channel *); /* SSH2-only */ 277 void chan_read_failed(Channel *); 278 void chan_ibuf_empty(Channel *); 279 280 void chan_rcvd_ieof(Channel *); 281 void chan_write_failed(Channel *); 282 void chan_obuf_empty(Channel *); 283 284 /* hpn handler */ 285 void channel_set_hpn(int, int); 286 287 #endif 288