1255767Sdes/* $OpenBSD: channels.h,v 1.113 2013/06/07 15:37:52 dtucker Exp $ */ 2224638Sbrooks/* $FreeBSD$ */ 392559Sdes 465668Skris/* 565668Skris * Author: Tatu Ylonen <ylo@cs.hut.fi> 665668Skris * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 765668Skris * All rights reserved 865668Skris * 965668Skris * As far as I am concerned, the code I have written for this software 1065668Skris * can be used freely for any purpose. Any derived versions of this 1165668Skris * software must be clearly marked as such, and if the derived work is 1265668Skris * incompatible with the protocol description in the RFC file, it must be 1365668Skris * called by a name other than "ssh" or "Secure Shell". 1465668Skris */ 1565668Skris/* 1692559Sdes * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved. 1765668Skris * 1865668Skris * Redistribution and use in source and binary forms, with or without 1965668Skris * modification, are permitted provided that the following conditions 2065668Skris * are met: 2165668Skris * 1. Redistributions of source code must retain the above copyright 2265668Skris * notice, this list of conditions and the following disclaimer. 2365668Skris * 2. Redistributions in binary form must reproduce the above copyright 2465668Skris * notice, this list of conditions and the following disclaimer in the 2565668Skris * documentation and/or other materials provided with the distribution. 2665668Skris * 2765668Skris * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 2865668Skris * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 2965668Skris * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 3065668Skris * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 3165668Skris * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 3265668Skris * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3365668Skris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3465668Skris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3565668Skris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 3665668Skris * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3765668Skris */ 3857429Smarkm 3992559Sdes#ifndef CHANNEL_H 4092559Sdes#define CHANNEL_H 4157429Smarkm 4257429Smarkm/* Definitions for channel types. */ 4357429Smarkm#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ 4457429Smarkm#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */ 4557429Smarkm#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */ 4657429Smarkm#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */ 4757429Smarkm#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */ 4860573Skris#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */ 4960573Skris#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */ 5060573Skris#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */ 5160573Skris#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */ 5260573Skris#define SSH_CHANNEL_LARVAL 10 /* larval session */ 5376262Sgreen#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ 5476262Sgreen#define SSH_CHANNEL_CONNECTING 12 5576262Sgreen#define SSH_CHANNEL_DYNAMIC 13 5692559Sdes#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ 57204917Sdes#define SSH_CHANNEL_MUX_LISTENER 15 /* Listener for mux conn. */ 58204917Sdes#define SSH_CHANNEL_MUX_CLIENT 16 /* Conn. to mux slave */ 59255767Sdes#define SSH_CHANNEL_ABANDONED 17 /* Abandoned session, eg mux */ 60255767Sdes#define SSH_CHANNEL_MAX_TYPE 18 6157429Smarkm 62240075Sdes#define CHANNEL_CANCEL_PORT_STATIC -1 63240075Sdes 6465668Skrisstruct Channel; 6565668Skristypedef struct Channel Channel; 6665668Skris 67215116Sdestypedef void channel_open_fn(int, int, void *); 6892559Sdestypedef void channel_callback_fn(int, void *); 69157019Sdestypedef int channel_infilter_fn(struct Channel *, char *, int); 70181111Sdestypedef void channel_filter_cleanup_fn(int, void *); 71157019Sdestypedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *); 7257429Smarkm 73181111Sdes/* Channel success/failure callbacks */ 74181111Sdestypedef void channel_confirm_cb(int, struct Channel *, void *); 75181111Sdestypedef void channel_confirm_abandon_cb(struct Channel *, void *); 76181111Sdesstruct channel_confirm { 77181111Sdes TAILQ_ENTRY(channel_confirm) entry; 78181111Sdes channel_confirm_cb *cb; 79181111Sdes channel_confirm_abandon_cb *abandon_cb; 80181111Sdes void *ctx; 81181111Sdes}; 82181111SdesTAILQ_HEAD(channel_confirms, channel_confirm); 83181111Sdes 84181111Sdes/* Context for non-blocking connects */ 85181111Sdesstruct channel_connect { 86181111Sdes char *host; 87181111Sdes int port; 88181111Sdes struct addrinfo *ai, *aitop; 89181111Sdes}; 90181111Sdes 91204917Sdes/* Callbacks for mux channels back into client-specific code */ 92204917Sdestypedef int mux_callback_fn(struct Channel *); 93204917Sdes 9465668Skrisstruct Channel { 9557429Smarkm int type; /* channel type/state */ 9657429Smarkm int self; /* my own channel identifier */ 9757429Smarkm int remote_id; /* channel identifier for remote peer */ 9892559Sdes u_int istate; /* input from channel (state of receive half) */ 9992559Sdes u_int ostate; /* output to channel (state of transmit half) */ 10060573Skris int flags; /* close sent/rcvd */ 10160573Skris int rfd; /* read fd */ 10260573Skris int wfd; /* write fd */ 10360573Skris int efd; /* extended fd */ 10460573Skris int sock; /* sock fd */ 105204917Sdes int ctl_chan; /* control channel (multiplexed connections) */ 10674500Sgreen int isatty; /* rfd is a tty */ 107255767Sdes#ifdef _AIX 108106130Sdes int wfd_isatty; /* wfd is a tty */ 109255767Sdes#endif 110147005Sdes int client_tty; /* (client) TTY has been requested */ 11192559Sdes int force_drain; /* force close on iEOF */ 112240075Sdes time_t notbefore; /* Pause IO until deadline (time_t) */ 113204917Sdes int delayed; /* post-select handlers for newly created 114204917Sdes * channels are delayed until the first call 115204917Sdes * to a matching pre-select handler. 116204917Sdes * this way post-select handlers are not 117255767Sdes * accidentally called if a FD gets reused */ 11857429Smarkm Buffer input; /* data read from socket, to be sent over 11957429Smarkm * encrypted connection */ 12057429Smarkm Buffer output; /* data received over encrypted connection for 12157429Smarkm * send on socket */ 12260573Skris Buffer extended; 123192595Sdes char *path; 12492559Sdes /* path for unix domain sockets, or host name for forwards */ 12557429Smarkm int listening_port; /* port being listened for forwards */ 126240075Sdes char *listening_addr; /* addr being listened for forwards */ 12757429Smarkm int host_port; /* remote port to connect for forwards */ 12857429Smarkm char *remote_name; /* remote hostname */ 12960573Skris 13099063Sdes u_int remote_window; 13199063Sdes u_int remote_maxpacket; 13299063Sdes u_int local_window; 13399063Sdes u_int local_window_max; 13499063Sdes u_int local_consumed; 13599063Sdes u_int local_maxpacket; 136231584Sed u_int tcpwinsz; 137224638Sbrooks int dynamic_window; 13860573Skris int extended_usage; 13992559Sdes int single_connection; 14060573Skris 14160573Skris char *ctype; /* type */ 14260573Skris 14360573Skris /* callback */ 144215116Sdes channel_open_fn *open_confirm; 145181111Sdes void *open_confirm_ctx; 14692559Sdes channel_callback_fn *detach_user; 147157019Sdes int detach_close; 148181111Sdes struct channel_confirms status_confirms; 14960573Skris 15065668Skris /* filter */ 151157019Sdes channel_infilter_fn *input_filter; 152157019Sdes channel_outfilter_fn *output_filter; 153181111Sdes void *filter_ctx; 154181111Sdes channel_filter_cleanup_fn *filter_cleanup; 155157019Sdes 156181111Sdes /* keep boundaries */ 157181111Sdes int datagram; 158181111Sdes 159181111Sdes /* non-blocking connect */ 160181111Sdes struct channel_connect connect_ctx; 161204917Sdes 162204917Sdes /* multiplexing protocol hook, called for each packet received */ 163204917Sdes mux_callback_fn *mux_rcb; 164204917Sdes void *mux_ctx; 165215116Sdes int mux_pause; 16665668Skris}; 16765668Skris 16860573Skris#define CHAN_EXTENDED_IGNORE 0 16960573Skris#define CHAN_EXTENDED_READ 1 17060573Skris#define CHAN_EXTENDED_WRITE 2 17160573Skris 17265668Skris/* default window/packet sizes for tcp/x11-fwd-channel */ 17392559Sdes#define CHAN_SES_PACKET_DEFAULT (32*1024) 174181111Sdes#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT) 17592559Sdes#define CHAN_TCP_PACKET_DEFAULT (32*1024) 176181111Sdes#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT) 17792559Sdes#define CHAN_X11_PACKET_DEFAULT (16*1024) 17892559Sdes#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) 179224638Sbrooks#define CHAN_HPN_MIN_WINDOW_DEFAULT (2*1024*1024) 180224638Sbrooks 18192559Sdes/* possible input states */ 18292559Sdes#define CHAN_INPUT_OPEN 0 18392559Sdes#define CHAN_INPUT_WAIT_DRAIN 1 18492559Sdes#define CHAN_INPUT_WAIT_OCLOSE 2 18592559Sdes#define CHAN_INPUT_CLOSED 3 18665668Skris 18792559Sdes/* possible output states */ 18892559Sdes#define CHAN_OUTPUT_OPEN 0 18992559Sdes#define CHAN_OUTPUT_WAIT_DRAIN 1 19092559Sdes#define CHAN_OUTPUT_WAIT_IEOF 2 19192559Sdes#define CHAN_OUTPUT_CLOSED 3 19260573Skris 19392559Sdes#define CHAN_CLOSE_SENT 0x01 19492559Sdes#define CHAN_CLOSE_RCVD 0x02 19598684Sdes#define CHAN_EOF_SENT 0x04 19698684Sdes#define CHAN_EOF_RCVD 0x08 197204917Sdes#define CHAN_LOCAL 0x10 19860573Skris 199157019Sdes#define CHAN_RBUF 16*1024 200157019Sdes 20198684Sdes/* check whether 'efd' is still in use */ 20298684Sdes#define CHANNEL_EFD_INPUT_ACTIVE(c) \ 20398684Sdes (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ 20498684Sdes (c->efd != -1 || \ 20598684Sdes buffer_len(&c->extended) > 0)) 20698684Sdes#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ 20798684Sdes (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ 208149753Sdes c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \ 20998684Sdes buffer_len(&c->extended) > 0)) 21098684Sdes 21192559Sdes/* channel management */ 21260573Skris 213157019SdesChannel *channel_by_id(int); 21492559SdesChannel *channel_lookup(int); 21599063SdesChannel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int); 216181111Sdesvoid channel_set_fds(int, int, int, int, int, int, int, u_int); 21792559Sdesvoid channel_free(Channel *); 21892559Sdesvoid channel_free_all(void); 21992559Sdesvoid channel_stop_listening(void); 22069587Sgreen 22192559Sdesvoid channel_send_open(int); 22292559Sdesvoid channel_request_start(int, char *, int); 223157019Sdesvoid channel_register_cleanup(int, channel_callback_fn *, int); 224215116Sdesvoid channel_register_open_confirm(int, channel_open_fn *, void *); 225181111Sdesvoid channel_register_filter(int, channel_infilter_fn *, 226181111Sdes channel_outfilter_fn *, channel_filter_cleanup_fn *, void *); 227181111Sdesvoid channel_register_status_confirm(int, channel_confirm_cb *, 228181111Sdes channel_confirm_abandon_cb *, void *); 22992559Sdesvoid channel_cancel_cleanup(int); 23092559Sdesint channel_close_fd(int *); 231137019Sdesvoid channel_send_window_changes(void); 23260573Skris 23392559Sdes/* protocol handler */ 23460573Skris 23592559Sdesvoid channel_input_close(int, u_int32_t, void *); 23692559Sdesvoid channel_input_close_confirmation(int, u_int32_t, void *); 23792559Sdesvoid channel_input_data(int, u_int32_t, void *); 23892559Sdesvoid channel_input_extended_data(int, u_int32_t, void *); 23992559Sdesvoid channel_input_ieof(int, u_int32_t, void *); 24092559Sdesvoid channel_input_oclose(int, u_int32_t, void *); 24192559Sdesvoid channel_input_open_confirmation(int, u_int32_t, void *); 24292559Sdesvoid channel_input_open_failure(int, u_int32_t, void *); 24392559Sdesvoid channel_input_port_open(int, u_int32_t, void *); 24492559Sdesvoid channel_input_window_adjust(int, u_int32_t, void *); 245181111Sdesvoid channel_input_status_confirm(int, u_int32_t, void *); 24660573Skris 24792559Sdes/* file descriptor handling (read/write) */ 24860573Skris 249240075Sdesvoid channel_prepare_select(fd_set **, fd_set **, int *, u_int*, 250240075Sdes time_t*, int); 25192559Sdesvoid channel_after_select(fd_set *, fd_set *); 25292559Sdesvoid channel_output_poll(void); 25360573Skris 25492559Sdesint channel_not_very_much_buffered_data(void); 25592559Sdesvoid channel_close_all(void); 25692559Sdesint channel_still_open(void); 25792559Sdeschar *channel_open_message(void); 25892559Sdesint channel_find_open(void); 25960573Skris 26092559Sdes/* tcp forwarding */ 26192559Sdesvoid channel_set_af(int af); 26292559Sdesvoid channel_permit_all_opens(void); 26392559Sdesvoid channel_add_permitted_opens(char *, int); 264162856Sdesint channel_add_adm_permitted_opens(char *, int); 265240075Sdesvoid channel_disable_adm_local_opens(void); 266240075Sdesvoid channel_update_permitted_opens(int, int); 26792559Sdesvoid channel_clear_permitted_opens(void); 268162856Sdesvoid channel_clear_adm_permitted_opens(void); 269181111Sdesvoid channel_print_adm_permitted_opens(void); 270162856Sdesint channel_input_port_forward_request(int, int); 271181111SdesChannel *channel_connect_to(const char *, u_short, char *, char *); 272204917SdesChannel *channel_connect_stdio_fwd(const char*, u_short, int, int); 273181111SdesChannel *channel_connect_by_listen_address(u_short, char *, char *); 274162856Sdesint channel_request_remote_forwarding(const char *, u_short, 275147005Sdes const char *, u_short); 276147005Sdesint channel_setup_local_fwd_listener(const char *, u_short, 277147005Sdes const char *, u_short, int); 278240075Sdesint channel_request_rforward_cancel(const char *host, u_short port); 279192595Sdesint channel_setup_remote_fwd_listener(const char *, u_short, int *, int); 280137019Sdesint channel_cancel_rport_listener(const char *, u_short); 281240075Sdesint channel_cancel_lport_listener(const char *, u_short, int, int); 282240075Sdesint permitopen_port(const char *); 28360573Skris 28492559Sdes/* x11 forwarding */ 28560573Skris 28692559Sdesint x11_connect_display(void); 287149753Sdesint x11_create_display_inet(int, int, int, u_int *, int **); 28892559Sdesvoid x11_input_open(int, u_int32_t, void *); 289149753Sdesvoid x11_request_forwarding_with_spoofing(int, const char *, const char *, 290226046Sdes const char *, int); 29192559Sdesvoid deny_input_open(int, u_int32_t, void *); 29260573Skris 29392559Sdes/* agent forwarding */ 29460573Skris 29592559Sdesvoid auth_request_forwarding(void); 29660573Skris 29792559Sdes/* channel close */ 29860573Skris 29992559Sdesint chan_is_dead(Channel *, int); 30092559Sdesvoid chan_mark_dead(Channel *); 30160573Skris 30292559Sdes/* channel events */ 30360573Skris 30492559Sdesvoid chan_rcvd_oclose(Channel *); 305181111Sdesvoid chan_rcvd_eow(Channel *); /* SSH2-only */ 30692559Sdesvoid chan_read_failed(Channel *); 30792559Sdesvoid chan_ibuf_empty(Channel *); 30876262Sgreen 30992559Sdesvoid chan_rcvd_ieof(Channel *); 31092559Sdesvoid chan_write_failed(Channel *); 31192559Sdesvoid chan_obuf_empty(Channel *); 31276262Sgreen 313224638Sbrooks/* hpn handler */ 314224638Sbrooks 315231584Sedvoid channel_set_hpn(int, u_int); 316231584Sed 31757429Smarkm#endif 318