channels.h revision 240075
1/* $OpenBSD: channels.h,v 1.111 2012/04/11 13:16:19 djm Exp $ */ 2/* $FreeBSD: head/crypto/openssh/channels.h 240075 2012-09-03 16:51:41Z des $ */ 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 61#define CHANNEL_CANCEL_PORT_STATIC -1 62 63struct Channel; 64typedef struct Channel Channel; 65 66typedef void channel_open_fn(int, int, void *); 67typedef void channel_callback_fn(int, void *); 68typedef int channel_infilter_fn(struct Channel *, char *, int); 69typedef void channel_filter_cleanup_fn(int, void *); 70typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *); 71 72/* Channel success/failure callbacks */ 73typedef void channel_confirm_cb(int, struct Channel *, void *); 74typedef void channel_confirm_abandon_cb(struct Channel *, void *); 75struct channel_confirm { 76 TAILQ_ENTRY(channel_confirm) entry; 77 channel_confirm_cb *cb; 78 channel_confirm_abandon_cb *abandon_cb; 79 void *ctx; 80}; 81TAILQ_HEAD(channel_confirms, channel_confirm); 82 83/* Context for non-blocking connects */ 84struct channel_connect { 85 char *host; 86 int port; 87 struct addrinfo *ai, *aitop; 88}; 89 90/* Callbacks for mux channels back into client-specific code */ 91typedef int mux_callback_fn(struct Channel *); 92 93struct Channel { 94 int type; /* channel type/state */ 95 int self; /* my own channel identifier */ 96 int remote_id; /* channel identifier for remote peer */ 97 u_int istate; /* input from channel (state of receive half) */ 98 u_int ostate; /* output to channel (state of transmit half) */ 99 int flags; /* close sent/rcvd */ 100 int rfd; /* read fd */ 101 int wfd; /* write fd */ 102 int efd; /* extended fd */ 103 int sock; /* sock fd */ 104 int ctl_chan; /* control channel (multiplexed connections) */ 105 int isatty; /* rfd is a tty */ 106 int wfd_isatty; /* wfd is a tty */ 107 int client_tty; /* (client) TTY has been requested */ 108 int force_drain; /* force close on iEOF */ 109 time_t notbefore; /* Pause IO until deadline (time_t) */ 110 int delayed; /* post-select handlers for newly created 111 * channels are delayed until the first call 112 * to a matching pre-select handler. 113 * this way post-select handlers are not 114 * accidenly called if a FD gets reused */ 115 Buffer input; /* data read from socket, to be sent over 116 * encrypted connection */ 117 Buffer output; /* data received over encrypted connection for 118 * send on socket */ 119 Buffer extended; 120 char *path; 121 /* path for unix domain sockets, or host name for forwards */ 122 int listening_port; /* port being listened for forwards */ 123 char *listening_addr; /* addr being listened for forwards */ 124 int host_port; /* remote port to connect for forwards */ 125 char *remote_name; /* remote hostname */ 126 127 u_int remote_window; 128 u_int remote_maxpacket; 129 u_int local_window; 130 u_int local_window_max; 131 u_int local_consumed; 132 u_int local_maxpacket; 133 u_int tcpwinsz; 134 int dynamic_window; 135 int extended_usage; 136 int single_connection; 137 138 char *ctype; /* type */ 139 140 /* callback */ 141 channel_open_fn *open_confirm; 142 void *open_confirm_ctx; 143 channel_callback_fn *detach_user; 144 int detach_close; 145 struct channel_confirms status_confirms; 146 147 /* filter */ 148 channel_infilter_fn *input_filter; 149 channel_outfilter_fn *output_filter; 150 void *filter_ctx; 151 channel_filter_cleanup_fn *filter_cleanup; 152 153 /* keep boundaries */ 154 int datagram; 155 156 /* non-blocking connect */ 157 struct channel_connect connect_ctx; 158 159 /* multiplexing protocol hook, called for each packet received */ 160 mux_callback_fn *mux_rcb; 161 void *mux_ctx; 162 int mux_pause; 163}; 164 165#define CHAN_EXTENDED_IGNORE 0 166#define CHAN_EXTENDED_READ 1 167#define CHAN_EXTENDED_WRITE 2 168 169/* default window/packet sizes for tcp/x11-fwd-channel */ 170#define CHAN_SES_PACKET_DEFAULT (32*1024) 171#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT) 172#define CHAN_TCP_PACKET_DEFAULT (32*1024) 173#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT) 174#define CHAN_X11_PACKET_DEFAULT (16*1024) 175#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) 176#define CHAN_HPN_MIN_WINDOW_DEFAULT (2*1024*1024) 177 178/* possible input states */ 179#define CHAN_INPUT_OPEN 0 180#define CHAN_INPUT_WAIT_DRAIN 1 181#define CHAN_INPUT_WAIT_OCLOSE 2 182#define CHAN_INPUT_CLOSED 3 183 184/* possible output states */ 185#define CHAN_OUTPUT_OPEN 0 186#define CHAN_OUTPUT_WAIT_DRAIN 1 187#define CHAN_OUTPUT_WAIT_IEOF 2 188#define CHAN_OUTPUT_CLOSED 3 189 190#define CHAN_CLOSE_SENT 0x01 191#define CHAN_CLOSE_RCVD 0x02 192#define CHAN_EOF_SENT 0x04 193#define CHAN_EOF_RCVD 0x08 194#define CHAN_LOCAL 0x10 195 196#define CHAN_RBUF 16*1024 197 198/* check whether 'efd' is still in use */ 199#define CHANNEL_EFD_INPUT_ACTIVE(c) \ 200 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ 201 (c->efd != -1 || \ 202 buffer_len(&c->extended) > 0)) 203#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ 204 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ 205 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \ 206 buffer_len(&c->extended) > 0)) 207 208/* channel management */ 209 210Channel *channel_by_id(int); 211Channel *channel_lookup(int); 212Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int); 213void channel_set_fds(int, int, int, int, int, int, int, u_int); 214void channel_free(Channel *); 215void channel_free_all(void); 216void channel_stop_listening(void); 217 218void channel_send_open(int); 219void channel_request_start(int, char *, int); 220void channel_register_cleanup(int, channel_callback_fn *, int); 221void channel_register_open_confirm(int, channel_open_fn *, void *); 222void channel_register_filter(int, channel_infilter_fn *, 223 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *); 224void channel_register_status_confirm(int, channel_confirm_cb *, 225 channel_confirm_abandon_cb *, void *); 226void channel_cancel_cleanup(int); 227int channel_close_fd(int *); 228void channel_send_window_changes(void); 229 230/* protocol handler */ 231 232void channel_input_close(int, u_int32_t, void *); 233void channel_input_close_confirmation(int, u_int32_t, void *); 234void channel_input_data(int, u_int32_t, void *); 235void channel_input_extended_data(int, u_int32_t, void *); 236void channel_input_ieof(int, u_int32_t, void *); 237void channel_input_oclose(int, u_int32_t, void *); 238void channel_input_open_confirmation(int, u_int32_t, void *); 239void channel_input_open_failure(int, u_int32_t, void *); 240void channel_input_port_open(int, u_int32_t, void *); 241void channel_input_window_adjust(int, u_int32_t, void *); 242void channel_input_status_confirm(int, u_int32_t, void *); 243 244/* file descriptor handling (read/write) */ 245 246void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, 247 time_t*, int); 248void channel_after_select(fd_set *, fd_set *); 249void channel_output_poll(void); 250 251int channel_not_very_much_buffered_data(void); 252void channel_close_all(void); 253int channel_still_open(void); 254char *channel_open_message(void); 255int channel_find_open(void); 256 257/* tcp forwarding */ 258void channel_set_af(int af); 259void channel_permit_all_opens(void); 260void channel_add_permitted_opens(char *, int); 261int channel_add_adm_permitted_opens(char *, int); 262void channel_disable_adm_local_opens(void); 263void channel_update_permitted_opens(int, int); 264void channel_clear_permitted_opens(void); 265void channel_clear_adm_permitted_opens(void); 266void channel_print_adm_permitted_opens(void); 267int channel_input_port_forward_request(int, int); 268Channel *channel_connect_to(const char *, u_short, char *, char *); 269Channel *channel_connect_stdio_fwd(const char*, u_short, int, int); 270Channel *channel_connect_by_listen_address(u_short, char *, char *); 271int channel_request_remote_forwarding(const char *, u_short, 272 const char *, u_short); 273int channel_setup_local_fwd_listener(const char *, u_short, 274 const char *, u_short, int); 275int channel_request_rforward_cancel(const char *host, u_short port); 276int channel_setup_remote_fwd_listener(const char *, u_short, int *, int); 277int channel_cancel_rport_listener(const char *, u_short); 278int channel_cancel_lport_listener(const char *, u_short, int, int); 279int permitopen_port(const char *); 280 281/* x11 forwarding */ 282 283int x11_connect_display(void); 284int x11_create_display_inet(int, int, int, u_int *, int **); 285void x11_input_open(int, u_int32_t, void *); 286void x11_request_forwarding_with_spoofing(int, const char *, const char *, 287 const char *, int); 288void deny_input_open(int, u_int32_t, void *); 289 290/* agent forwarding */ 291 292void auth_request_forwarding(void); 293 294/* channel close */ 295 296int chan_is_dead(Channel *, int); 297void chan_mark_dead(Channel *); 298 299/* channel events */ 300 301void chan_rcvd_oclose(Channel *); 302void chan_rcvd_eow(Channel *); /* SSH2-only */ 303void chan_read_failed(Channel *); 304void chan_ibuf_empty(Channel *); 305 306void chan_rcvd_ieof(Channel *); 307void chan_write_failed(Channel *); 308void chan_obuf_empty(Channel *); 309 310/* hpn handler */ 311 312void channel_set_hpn(int, u_int); 313 314#endif 315