channels.h revision 98941
1216390Sjchandra/* $OpenBSD: channels.h,v 1.68 2002/06/10 22:28:41 markus Exp $ */ 2216390Sjchandra 3216390Sjchandra/* 4216390Sjchandra * Author: Tatu Ylonen <ylo@cs.hut.fi> 5216390Sjchandra * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 6216390Sjchandra * All rights reserved 7216390Sjchandra * 8216390Sjchandra * As far as I am concerned, the code I have written for this software 9216390Sjchandra * can be used freely for any purpose. Any derived versions of this 10216390Sjchandra * software must be clearly marked as such, and if the derived work is 11216390Sjchandra * incompatible with the protocol description in the RFC file, it must be 12216390Sjchandra * called by a name other than "ssh" or "Secure Shell". 13216390Sjchandra */ 14216390Sjchandra/* 15216390Sjchandra * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved. 16216390Sjchandra * 17216390Sjchandra * Redistribution and use in source and binary forms, with or without 18216390Sjchandra * modification, are permitted provided that the following conditions 19216390Sjchandra * are met: 20216390Sjchandra * 1. Redistributions of source code must retain the above copyright 21216390Sjchandra * notice, this list of conditions and the following disclaimer. 22216390Sjchandra * 2. Redistributions in binary form must reproduce the above copyright 23216390Sjchandra * notice, this list of conditions and the following disclaimer in the 24216390Sjchandra * documentation and/or other materials provided with the distribution. 25216390Sjchandra * 26216390Sjchandra * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 27216390Sjchandra * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 28216390Sjchandra * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 29216390Sjchandra * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 30216390Sjchandra * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 31216390Sjchandra * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 32216390Sjchandra * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 33216390Sjchandra * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 34216390Sjchandra * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 35216390Sjchandra * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 36216390Sjchandra */ 37216390Sjchandra 38216390Sjchandra#ifndef CHANNEL_H 39216390Sjchandra#define CHANNEL_H 40216390Sjchandra 41216390Sjchandra#include "buffer.h" 42216390Sjchandra 43216390Sjchandra/* Definitions for channel types. */ 44216390Sjchandra#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ 45216390Sjchandra#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */ 46216390Sjchandra#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */ 47216390Sjchandra#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */ 48216390Sjchandra#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */ 49216390Sjchandra#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */ 50216390Sjchandra#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */ 51216390Sjchandra#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */ 52216390Sjchandra#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */ 53216390Sjchandra#define SSH_CHANNEL_LARVAL 10 /* larval session */ 54216390Sjchandra#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ 55216390Sjchandra#define SSH_CHANNEL_CONNECTING 12 56216390Sjchandra#define SSH_CHANNEL_DYNAMIC 13 57216390Sjchandra#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ 58216390Sjchandra#define SSH_CHANNEL_MAX_TYPE 15 59216390Sjchandra 60216390Sjchandra#define SSH_CHANNEL_PATH_LEN 256 61216390Sjchandra 62216390Sjchandrastruct Channel; 63216390Sjchandratypedef struct Channel Channel; 64216390Sjchandra 65216390Sjchandratypedef void channel_callback_fn(int, void *); 66216390Sjchandratypedef int channel_filter_fn(struct Channel *, char *, int); 67216390Sjchandra 68216390Sjchandrastruct Channel { 69216390Sjchandra int type; /* channel type/state */ 70216390Sjchandra int self; /* my own channel identifier */ 71216390Sjchandra int remote_id; /* channel identifier for remote peer */ 72216390Sjchandra u_int istate; /* input from channel (state of receive half) */ 73216390Sjchandra u_int ostate; /* output to channel (state of transmit half) */ 74216390Sjchandra int flags; /* close sent/rcvd */ 75216390Sjchandra int rfd; /* read fd */ 76216390Sjchandra int wfd; /* write fd */ 77216390Sjchandra int efd; /* extended fd */ 78216390Sjchandra int sock; /* sock fd */ 79216390Sjchandra int isatty; /* rfd is a tty */ 80216390Sjchandra int force_drain; /* force close on iEOF */ 81216390Sjchandra int delayed; /* fdset hack */ 82216390Sjchandra Buffer input; /* data read from socket, to be sent over 83216390Sjchandra * encrypted connection */ 84216390Sjchandra Buffer output; /* data received over encrypted connection for 85216390Sjchandra * send on socket */ 86216390Sjchandra Buffer extended; 87216390Sjchandra char path[SSH_CHANNEL_PATH_LEN]; 88216390Sjchandra /* path for unix domain sockets, or host name for forwards */ 89216390Sjchandra int listening_port; /* port being listened for forwards */ 90216390Sjchandra int host_port; /* remote port to connect for forwards */ 91216390Sjchandra char *remote_name; /* remote hostname */ 92216390Sjchandra 93216390Sjchandra int remote_window; 94216390Sjchandra int remote_maxpacket; 95216390Sjchandra int local_window; 96216390Sjchandra int local_window_max; 97216390Sjchandra int local_consumed; 98216390Sjchandra int local_maxpacket; 99216390Sjchandra int extended_usage; 100216390Sjchandra int single_connection; 101216390Sjchandra 102216390Sjchandra char *ctype; /* type */ 103216390Sjchandra 104216390Sjchandra /* callback */ 105216390Sjchandra channel_callback_fn *confirm; 106216390Sjchandra channel_callback_fn *detach_user; 107216390Sjchandra 108216390Sjchandra /* filter */ 109216390Sjchandra channel_filter_fn *input_filter; 110216390Sjchandra}; 111216390Sjchandra 112216390Sjchandra#define CHAN_EXTENDED_IGNORE 0 113216390Sjchandra#define CHAN_EXTENDED_READ 1 114216390Sjchandra#define CHAN_EXTENDED_WRITE 2 115216390Sjchandra 116216390Sjchandra/* default window/packet sizes for tcp/x11-fwd-channel */ 117216390Sjchandra#define CHAN_SES_PACKET_DEFAULT (32*1024) 118216390Sjchandra#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT) 119216390Sjchandra#define CHAN_TCP_PACKET_DEFAULT (32*1024) 120216390Sjchandra#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT) 121216390Sjchandra#define CHAN_X11_PACKET_DEFAULT (16*1024) 122216390Sjchandra#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) 123216390Sjchandra 124216390Sjchandra/* possible input states */ 125216390Sjchandra#define CHAN_INPUT_OPEN 0 126216390Sjchandra#define CHAN_INPUT_WAIT_DRAIN 1 127216390Sjchandra#define CHAN_INPUT_WAIT_OCLOSE 2 128216390Sjchandra#define CHAN_INPUT_CLOSED 3 129216390Sjchandra 130216390Sjchandra/* possible output states */ 131216390Sjchandra#define CHAN_OUTPUT_OPEN 0 132216390Sjchandra#define CHAN_OUTPUT_WAIT_DRAIN 1 133216390Sjchandra#define CHAN_OUTPUT_WAIT_IEOF 2 134216390Sjchandra#define CHAN_OUTPUT_CLOSED 3 135216390Sjchandra 136216390Sjchandra#define CHAN_CLOSE_SENT 0x01 137216390Sjchandra#define CHAN_CLOSE_RCVD 0x02 138216390Sjchandra#define CHAN_EOF_SENT 0x04 139216390Sjchandra#define CHAN_EOF_RCVD 0x08 140216390Sjchandra 141/* check whether 'efd' is still in use */ 142#define CHANNEL_EFD_INPUT_ACTIVE(c) \ 143 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ 144 (c->efd != -1 || \ 145 buffer_len(&c->extended) > 0)) 146#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ 147 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ 148 ((c->efd != -1 && !(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD))) || \ 149 buffer_len(&c->extended) > 0)) 150 151/* channel management */ 152 153Channel *channel_lookup(int); 154Channel *channel_new(char *, int, int, int, int, int, int, int, char *, int); 155void channel_set_fds(int, int, int, int, int, int, u_int); 156void channel_free(Channel *); 157void channel_free_all(void); 158void channel_stop_listening(void); 159 160void channel_send_open(int); 161void channel_request_start(int, char *, int); 162void channel_register_cleanup(int, channel_callback_fn *); 163void channel_register_confirm(int, channel_callback_fn *); 164void channel_register_filter(int, channel_filter_fn *); 165void channel_cancel_cleanup(int); 166int channel_close_fd(int *); 167 168/* protocol handler */ 169 170void channel_input_close(int, u_int32_t, void *); 171void channel_input_close_confirmation(int, u_int32_t, void *); 172void channel_input_data(int, u_int32_t, void *); 173void channel_input_extended_data(int, u_int32_t, void *); 174void channel_input_ieof(int, u_int32_t, void *); 175void channel_input_oclose(int, u_int32_t, void *); 176void channel_input_open_confirmation(int, u_int32_t, void *); 177void channel_input_open_failure(int, u_int32_t, void *); 178void channel_input_port_open(int, u_int32_t, void *); 179void channel_input_window_adjust(int, u_int32_t, void *); 180 181/* file descriptor handling (read/write) */ 182 183void channel_prepare_select(fd_set **, fd_set **, int *, int*, int); 184void channel_after_select(fd_set *, fd_set *); 185void channel_output_poll(void); 186 187int channel_not_very_much_buffered_data(void); 188void channel_close_all(void); 189int channel_still_open(void); 190char *channel_open_message(void); 191int channel_find_open(void); 192 193/* tcp forwarding */ 194void channel_set_af(int af); 195void channel_permit_all_opens(void); 196void channel_add_permitted_opens(char *, int); 197void channel_clear_permitted_opens(void); 198void channel_input_port_forward_request(int, int); 199int channel_connect_to(const char *, u_short); 200int channel_connect_by_listen_address(u_short); 201void channel_request_remote_forwarding(u_short, const char *, u_short); 202int channel_setup_local_fwd_listener(u_short, const char *, u_short, int); 203int channel_setup_remote_fwd_listener(const char *, u_short, int); 204 205/* x11 forwarding */ 206 207int x11_connect_display(void); 208int x11_create_display_inet(int, int, int); 209void x11_input_open(int, u_int32_t, void *); 210void x11_request_forwarding_with_spoofing(int, const char *, const char *); 211void deny_input_open(int, u_int32_t, void *); 212 213/* agent forwarding */ 214 215void auth_request_forwarding(void); 216void auth_input_open_request(int, u_int32_t, void *); 217 218/* channel close */ 219 220int chan_is_dead(Channel *, int); 221void chan_mark_dead(Channel *); 222 223/* channel events */ 224 225void chan_rcvd_oclose(Channel *); 226void chan_read_failed(Channel *); 227void chan_ibuf_empty(Channel *); 228 229void chan_rcvd_ieof(Channel *); 230void chan_write_failed(Channel *); 231void chan_obuf_empty(Channel *); 232 233#endif 234