channels.h revision 231584
1/* $OpenBSD: channels.h,v 1.105 2011/06/22 22:08:42 djm Exp $ */ 2/* $FreeBSD: head/crypto/openssh/channels.h 231584 2012-02-13 11:59:59Z ed $ */ 3 4/* 5 * Author: Tatu Ylonen <ylo@cs.hut.fi> 6 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 7 * All rights reserved 8 * 9 * As far as I am concerned, the code I have written for this software 10 * can be used freely for any purpose. Any derived versions of this 11 * software must be clearly marked as such, and if the derived work is 12 * incompatible with the protocol description in the RFC file, it must be 13 * called by a name other than "ssh" or "Secure Shell". 14 */ 15/* 16 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved. 17 * 18 * Redistribution and use in source and binary forms, with or without 19 * modification, are permitted provided that the following conditions 20 * are met: 21 * 1. Redistributions of source code must retain the above copyright 22 * notice, this list of conditions and the following disclaimer. 23 * 2. Redistributions in binary form must reproduce the above copyright 24 * notice, this list of conditions and the following disclaimer in the 25 * documentation and/or other materials provided with the distribution. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 28 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 29 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 30 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 31 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 32 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 36 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39#ifndef CHANNEL_H 40#define CHANNEL_H 41 42/* Definitions for channel types. */ 43#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ 44#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */ 45#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */ 46#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */ 47#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */ 48#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */ 49#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */ 50#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */ 51#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */ 52#define SSH_CHANNEL_LARVAL 10 /* larval session */ 53#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ 54#define SSH_CHANNEL_CONNECTING 12 55#define SSH_CHANNEL_DYNAMIC 13 56#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ 57#define SSH_CHANNEL_MUX_LISTENER 15 /* Listener for mux conn. */ 58#define SSH_CHANNEL_MUX_CLIENT 16 /* Conn. to mux slave */ 59#define SSH_CHANNEL_MAX_TYPE 17 60 61struct Channel; 62typedef struct Channel Channel; 63 64typedef void channel_open_fn(int, int, void *); 65typedef void channel_callback_fn(int, void *); 66typedef int channel_infilter_fn(struct Channel *, char *, int); 67typedef void channel_filter_cleanup_fn(int, void *); 68typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *); 69 70/* Channel success/failure callbacks */ 71typedef void channel_confirm_cb(int, struct Channel *, void *); 72typedef void channel_confirm_abandon_cb(struct Channel *, void *); 73struct channel_confirm { 74 TAILQ_ENTRY(channel_confirm) entry; 75 channel_confirm_cb *cb; 76 channel_confirm_abandon_cb *abandon_cb; 77 void *ctx; 78}; 79TAILQ_HEAD(channel_confirms, channel_confirm); 80 81/* Context for non-blocking connects */ 82struct channel_connect { 83 char *host; 84 int port; 85 struct addrinfo *ai, *aitop; 86}; 87 88/* Callbacks for mux channels back into client-specific code */ 89typedef int mux_callback_fn(struct Channel *); 90 91struct Channel { 92 int type; /* channel type/state */ 93 int self; /* my own channel identifier */ 94 int remote_id; /* channel identifier for remote peer */ 95 u_int istate; /* input from channel (state of receive half) */ 96 u_int ostate; /* output to channel (state of transmit half) */ 97 int flags; /* close sent/rcvd */ 98 int rfd; /* read fd */ 99 int wfd; /* write fd */ 100 int efd; /* extended fd */ 101 int sock; /* sock fd */ 102 int ctl_chan; /* control channel (multiplexed connections) */ 103 int isatty; /* rfd is a tty */ 104 int wfd_isatty; /* wfd is a tty */ 105 int client_tty; /* (client) TTY has been requested */ 106 int force_drain; /* force close on iEOF */ 107 int delayed; /* post-select handlers for newly created 108 * channels are delayed until the first call 109 * to a matching pre-select handler. 110 * this way post-select handlers are not 111 * accidenly called if a FD gets reused */ 112 Buffer input; /* data read from socket, to be sent over 113 * encrypted connection */ 114 Buffer output; /* data received over encrypted connection for 115 * send on socket */ 116 Buffer extended; 117 char *path; 118 /* path for unix domain sockets, or host name for forwards */ 119 int listening_port; /* port being listened for forwards */ 120 int host_port; /* remote port to connect for forwards */ 121 char *remote_name; /* remote hostname */ 122 123 u_int remote_window; 124 u_int remote_maxpacket; 125 u_int local_window; 126 u_int local_window_max; 127 u_int local_consumed; 128 u_int local_maxpacket; 129 u_int tcpwinsz; 130 int dynamic_window; 131 int extended_usage; 132 int single_connection; 133 134 char *ctype; /* type */ 135 136 /* callback */ 137 channel_open_fn *open_confirm; 138 void *open_confirm_ctx; 139 channel_callback_fn *detach_user; 140 int detach_close; 141 struct channel_confirms status_confirms; 142 143 /* filter */ 144 channel_infilter_fn *input_filter; 145 channel_outfilter_fn *output_filter; 146 void *filter_ctx; 147 channel_filter_cleanup_fn *filter_cleanup; 148 149 /* keep boundaries */ 150 int datagram; 151 152 /* non-blocking connect */ 153 struct channel_connect connect_ctx; 154 155 /* multiplexing protocol hook, called for each packet received */ 156 mux_callback_fn *mux_rcb; 157 void *mux_ctx; 158 int mux_pause; 159}; 160 161#define CHAN_EXTENDED_IGNORE 0 162#define CHAN_EXTENDED_READ 1 163#define CHAN_EXTENDED_WRITE 2 164 165/* default window/packet sizes for tcp/x11-fwd-channel */ 166#define CHAN_SES_PACKET_DEFAULT (32*1024) 167#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT) 168#define CHAN_TCP_PACKET_DEFAULT (32*1024) 169#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT) 170#define CHAN_X11_PACKET_DEFAULT (16*1024) 171#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) 172#define CHAN_HPN_MIN_WINDOW_DEFAULT (2*1024*1024) 173 174/* possible input states */ 175#define CHAN_INPUT_OPEN 0 176#define CHAN_INPUT_WAIT_DRAIN 1 177#define CHAN_INPUT_WAIT_OCLOSE 2 178#define CHAN_INPUT_CLOSED 3 179 180/* possible output states */ 181#define CHAN_OUTPUT_OPEN 0 182#define CHAN_OUTPUT_WAIT_DRAIN 1 183#define CHAN_OUTPUT_WAIT_IEOF 2 184#define CHAN_OUTPUT_CLOSED 3 185 186#define CHAN_CLOSE_SENT 0x01 187#define CHAN_CLOSE_RCVD 0x02 188#define CHAN_EOF_SENT 0x04 189#define CHAN_EOF_RCVD 0x08 190#define CHAN_LOCAL 0x10 191 192#define CHAN_RBUF 16*1024 193 194/* check whether 'efd' is still in use */ 195#define CHANNEL_EFD_INPUT_ACTIVE(c) \ 196 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ 197 (c->efd != -1 || \ 198 buffer_len(&c->extended) > 0)) 199#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ 200 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ 201 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \ 202 buffer_len(&c->extended) > 0)) 203 204/* channel management */ 205 206Channel *channel_by_id(int); 207Channel *channel_lookup(int); 208Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int); 209void channel_set_fds(int, int, int, int, int, int, int, u_int); 210void channel_free(Channel *); 211void channel_free_all(void); 212void channel_stop_listening(void); 213 214void channel_send_open(int); 215void channel_request_start(int, char *, int); 216void channel_register_cleanup(int, channel_callback_fn *, int); 217void channel_register_open_confirm(int, channel_open_fn *, void *); 218void channel_register_filter(int, channel_infilter_fn *, 219 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *); 220void channel_register_status_confirm(int, channel_confirm_cb *, 221 channel_confirm_abandon_cb *, void *); 222void channel_cancel_cleanup(int); 223int channel_close_fd(int *); 224void channel_send_window_changes(void); 225 226/* protocol handler */ 227 228void channel_input_close(int, u_int32_t, void *); 229void channel_input_close_confirmation(int, u_int32_t, void *); 230void channel_input_data(int, u_int32_t, void *); 231void channel_input_extended_data(int, u_int32_t, void *); 232void channel_input_ieof(int, u_int32_t, void *); 233void channel_input_oclose(int, u_int32_t, void *); 234void channel_input_open_confirmation(int, u_int32_t, void *); 235void channel_input_open_failure(int, u_int32_t, void *); 236void channel_input_port_open(int, u_int32_t, void *); 237void channel_input_window_adjust(int, u_int32_t, void *); 238void channel_input_status_confirm(int, u_int32_t, void *); 239 240/* file descriptor handling (read/write) */ 241 242void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int); 243void channel_after_select(fd_set *, fd_set *); 244void channel_output_poll(void); 245 246int channel_not_very_much_buffered_data(void); 247void channel_close_all(void); 248int channel_still_open(void); 249char *channel_open_message(void); 250int channel_find_open(void); 251 252/* tcp forwarding */ 253void channel_set_af(int af); 254void channel_permit_all_opens(void); 255void channel_add_permitted_opens(char *, int); 256int channel_add_adm_permitted_opens(char *, int); 257void channel_clear_permitted_opens(void); 258void channel_clear_adm_permitted_opens(void); 259void channel_print_adm_permitted_opens(void); 260int channel_input_port_forward_request(int, int); 261Channel *channel_connect_to(const char *, u_short, char *, char *); 262Channel *channel_connect_stdio_fwd(const char*, u_short, int, int); 263Channel *channel_connect_by_listen_address(u_short, char *, char *); 264int channel_request_remote_forwarding(const char *, u_short, 265 const char *, u_short); 266int channel_setup_local_fwd_listener(const char *, u_short, 267 const char *, u_short, int); 268void channel_request_rforward_cancel(const char *host, u_short port); 269int channel_setup_remote_fwd_listener(const char *, u_short, int *, int); 270int channel_cancel_rport_listener(const char *, u_short); 271 272/* x11 forwarding */ 273 274int x11_connect_display(void); 275int x11_create_display_inet(int, int, int, u_int *, int **); 276void x11_input_open(int, u_int32_t, void *); 277void x11_request_forwarding_with_spoofing(int, const char *, const char *, 278 const char *, int); 279void deny_input_open(int, u_int32_t, void *); 280 281/* agent forwarding */ 282 283void auth_request_forwarding(void); 284 285/* channel close */ 286 287int chan_is_dead(Channel *, int); 288void chan_mark_dead(Channel *); 289 290/* channel events */ 291 292void chan_rcvd_oclose(Channel *); 293void chan_rcvd_eow(Channel *); /* SSH2-only */ 294void chan_read_failed(Channel *); 295void chan_ibuf_empty(Channel *); 296 297void chan_rcvd_ieof(Channel *); 298void chan_write_failed(Channel *); 299void chan_obuf_empty(Channel *); 300 301/* hpn handler */ 302 303void channel_set_hpn(int, u_int); 304 305#endif 306