channels.h revision 99063
199063Sdes/* $OpenBSD: channels.h,v 1.70 2002/06/24 14:33:27 markus Exp $ */ 299063Sdes/* $FreeBSD: head/crypto/openssh/channels.h 99063 2002-06-29 11:48:59Z des $ */ 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 4276262Sgreen#include "buffer.h" 4376262Sgreen 4457429Smarkm/* Definitions for channel types. */ 4557429Smarkm#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ 4657429Smarkm#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */ 4757429Smarkm#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */ 4857429Smarkm#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */ 4957429Smarkm#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */ 5060573Skris#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */ 5160573Skris#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */ 5260573Skris#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */ 5360573Skris#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */ 5460573Skris#define SSH_CHANNEL_LARVAL 10 /* larval session */ 5576262Sgreen#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ 5676262Sgreen#define SSH_CHANNEL_CONNECTING 12 5776262Sgreen#define SSH_CHANNEL_DYNAMIC 13 5892559Sdes#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ 5992559Sdes#define SSH_CHANNEL_MAX_TYPE 15 6057429Smarkm 6192559Sdes#define SSH_CHANNEL_PATH_LEN 256 6292559Sdes 6365668Skrisstruct Channel; 6465668Skristypedef struct Channel Channel; 6565668Skris 6692559Sdestypedef void channel_callback_fn(int, void *); 6792559Sdestypedef int channel_filter_fn(struct Channel *, char *, int); 6857429Smarkm 6965668Skrisstruct Channel { 7057429Smarkm int type; /* channel type/state */ 7157429Smarkm int self; /* my own channel identifier */ 7257429Smarkm int remote_id; /* channel identifier for remote peer */ 7392559Sdes u_int istate; /* input from channel (state of receive half) */ 7492559Sdes u_int ostate; /* output to channel (state of transmit half) */ 7560573Skris int flags; /* close sent/rcvd */ 7660573Skris int rfd; /* read fd */ 7760573Skris int wfd; /* write fd */ 7860573Skris int efd; /* extended fd */ 7960573Skris int sock; /* sock fd */ 8074500Sgreen int isatty; /* rfd is a tty */ 8192559Sdes int force_drain; /* force close on iEOF */ 8292559Sdes int delayed; /* fdset hack */ 8357429Smarkm Buffer input; /* data read from socket, to be sent over 8457429Smarkm * encrypted connection */ 8557429Smarkm Buffer output; /* data received over encrypted connection for 8657429Smarkm * send on socket */ 8760573Skris Buffer extended; 8892559Sdes char path[SSH_CHANNEL_PATH_LEN]; 8992559Sdes /* path for unix domain sockets, or host name for forwards */ 9057429Smarkm int listening_port; /* port being listened for forwards */ 9157429Smarkm int host_port; /* remote port to connect for forwards */ 9257429Smarkm char *remote_name; /* remote hostname */ 9360573Skris 9499063Sdes u_int remote_window; 9599063Sdes u_int remote_maxpacket; 9699063Sdes u_int local_window; 9799063Sdes u_int local_window_max; 9899063Sdes u_int local_consumed; 9999063Sdes u_int local_maxpacket; 10060573Skris int extended_usage; 10192559Sdes int single_connection; 10260573Skris 10360573Skris char *ctype; /* type */ 10460573Skris 10560573Skris /* callback */ 10692559Sdes channel_callback_fn *confirm; 10792559Sdes channel_callback_fn *detach_user; 10860573Skris 10965668Skris /* filter */ 11065668Skris channel_filter_fn *input_filter; 11165668Skris}; 11265668Skris 11360573Skris#define CHAN_EXTENDED_IGNORE 0 11460573Skris#define CHAN_EXTENDED_READ 1 11560573Skris#define CHAN_EXTENDED_WRITE 2 11660573Skris 11765668Skris/* default window/packet sizes for tcp/x11-fwd-channel */ 11892559Sdes#define CHAN_SES_PACKET_DEFAULT (32*1024) 11992559Sdes#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT) 12092559Sdes#define CHAN_TCP_PACKET_DEFAULT (32*1024) 12192559Sdes#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT) 12292559Sdes#define CHAN_X11_PACKET_DEFAULT (16*1024) 12392559Sdes#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) 12465668Skris 12592559Sdes/* possible input states */ 12692559Sdes#define CHAN_INPUT_OPEN 0 12792559Sdes#define CHAN_INPUT_WAIT_DRAIN 1 12892559Sdes#define CHAN_INPUT_WAIT_OCLOSE 2 12992559Sdes#define CHAN_INPUT_CLOSED 3 13065668Skris 13192559Sdes/* possible output states */ 13292559Sdes#define CHAN_OUTPUT_OPEN 0 13392559Sdes#define CHAN_OUTPUT_WAIT_DRAIN 1 13492559Sdes#define CHAN_OUTPUT_WAIT_IEOF 2 13592559Sdes#define CHAN_OUTPUT_CLOSED 3 13660573Skris 13792559Sdes#define CHAN_CLOSE_SENT 0x01 13892559Sdes#define CHAN_CLOSE_RCVD 0x02 13998684Sdes#define CHAN_EOF_SENT 0x04 14098684Sdes#define CHAN_EOF_RCVD 0x08 14160573Skris 14298684Sdes/* check whether 'efd' is still in use */ 14398684Sdes#define CHANNEL_EFD_INPUT_ACTIVE(c) \ 14498684Sdes (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ 14598684Sdes (c->efd != -1 || \ 14698684Sdes buffer_len(&c->extended) > 0)) 14798684Sdes#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ 14898684Sdes (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ 14998684Sdes ((c->efd != -1 && !(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD))) || \ 15098684Sdes buffer_len(&c->extended) > 0)) 15198684Sdes 15292559Sdes/* channel management */ 15360573Skris 15492559SdesChannel *channel_lookup(int); 15599063SdesChannel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int); 15692559Sdesvoid channel_set_fds(int, int, int, int, int, int, u_int); 15792559Sdesvoid channel_free(Channel *); 15892559Sdesvoid channel_free_all(void); 15992559Sdesvoid channel_stop_listening(void); 16069587Sgreen 16192559Sdesvoid channel_send_open(int); 16292559Sdesvoid channel_request_start(int, char *, int); 16392559Sdesvoid channel_register_cleanup(int, channel_callback_fn *); 16492559Sdesvoid channel_register_confirm(int, channel_callback_fn *); 16592559Sdesvoid channel_register_filter(int, channel_filter_fn *); 16692559Sdesvoid channel_cancel_cleanup(int); 16792559Sdesint channel_close_fd(int *); 16860573Skris 16992559Sdes/* protocol handler */ 17060573Skris 17192559Sdesvoid channel_input_close(int, u_int32_t, void *); 17292559Sdesvoid channel_input_close_confirmation(int, u_int32_t, void *); 17392559Sdesvoid channel_input_data(int, u_int32_t, void *); 17492559Sdesvoid channel_input_extended_data(int, u_int32_t, void *); 17592559Sdesvoid channel_input_ieof(int, u_int32_t, void *); 17692559Sdesvoid channel_input_oclose(int, u_int32_t, void *); 17792559Sdesvoid channel_input_open_confirmation(int, u_int32_t, void *); 17892559Sdesvoid channel_input_open_failure(int, u_int32_t, void *); 17992559Sdesvoid channel_input_port_open(int, u_int32_t, void *); 18092559Sdesvoid channel_input_window_adjust(int, u_int32_t, void *); 18160573Skris 18292559Sdes/* file descriptor handling (read/write) */ 18360573Skris 18492559Sdesvoid channel_prepare_select(fd_set **, fd_set **, int *, int*, int); 18592559Sdesvoid channel_after_select(fd_set *, fd_set *); 18692559Sdesvoid channel_output_poll(void); 18760573Skris 18892559Sdesint channel_not_very_much_buffered_data(void); 18992559Sdesvoid channel_close_all(void); 19092559Sdesint channel_still_open(void); 19192559Sdeschar *channel_open_message(void); 19292559Sdesint channel_find_open(void); 19360573Skris 19492559Sdes/* tcp forwarding */ 19592559Sdesvoid channel_set_af(int af); 19692559Sdesvoid channel_permit_all_opens(void); 19792559Sdesvoid channel_add_permitted_opens(char *, int); 19892559Sdesvoid channel_clear_permitted_opens(void); 19992559Sdesvoid channel_input_port_forward_request(int, int); 20092559Sdesint channel_connect_to(const char *, u_short); 20192559Sdesint channel_connect_by_listen_address(u_short); 20292559Sdesvoid channel_request_remote_forwarding(u_short, const char *, u_short); 20392559Sdesint channel_setup_local_fwd_listener(u_short, const char *, u_short, int); 20492559Sdesint channel_setup_remote_fwd_listener(const char *, u_short, int); 20560573Skris 20692559Sdes/* x11 forwarding */ 20760573Skris 20892559Sdesint x11_connect_display(void); 20999063Sdesint x11_create_display_inet(int, int, int, u_int *); 21092559Sdesvoid x11_input_open(int, u_int32_t, void *); 21192559Sdesvoid x11_request_forwarding_with_spoofing(int, const char *, const char *); 21292559Sdesvoid deny_input_open(int, u_int32_t, void *); 21360573Skris 21492559Sdes/* agent forwarding */ 21560573Skris 21692559Sdesvoid auth_request_forwarding(void); 21792559Sdesvoid auth_input_open_request(int, u_int32_t, void *); 21860573Skris 21992559Sdes/* channel close */ 22060573Skris 22192559Sdesint chan_is_dead(Channel *, int); 22292559Sdesvoid chan_mark_dead(Channel *); 22360573Skris 22492559Sdes/* channel events */ 22560573Skris 22692559Sdesvoid chan_rcvd_oclose(Channel *); 22792559Sdesvoid chan_read_failed(Channel *); 22892559Sdesvoid chan_ibuf_empty(Channel *); 22976262Sgreen 23092559Sdesvoid chan_rcvd_ieof(Channel *); 23192559Sdesvoid chan_write_failed(Channel *); 23292559Sdesvoid chan_obuf_empty(Channel *); 23376262Sgreen 23457429Smarkm#endif 235