blob: a97dd90071292fc6b8a6943033c78ae0d836dcce [file] [log] [blame]
Damien Miller077b2382005-12-31 16:22:32 +11001/* $OpenBSD: channels.h,v 1.83 2005/12/30 15:56:37 reyk Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millere4340be2000-09-16 13:29:08 +11003/*
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
7 *
8 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
13 */
14/*
Damien Millerb51ed392002-01-22 23:29:03 +110015 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110016 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
19 * are met:
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100037
Ben Lindstrome9c99912001-06-09 00:41:05 +000038#ifndef CHANNEL_H
39#define CHANNEL_H
Damien Millerd4a8b7e1999-10-27 13:42:43 +100040
Ben Lindstrom7bb8b492001-03-17 00:47:54 +000041#include "buffer.h"
42
Damien Millerd4a8b7e1999-10-27 13:42:43 +100043/* Definitions for channel types. */
Damien Miller5428f641999-11-25 11:54:57 +110044#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
Damien Miller95def091999-11-25 00:26:21 +110045#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
46#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
47#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
Damien Miller5428f641999-11-25 11:54:57 +110048#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
Damien Millerb38eff82000-04-01 11:09:21 +100049#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
50#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
51#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
52#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
53#define SSH_CHANNEL_LARVAL 10 /* larval session */
Damien Miller0bc1bd82000-11-13 22:57:25 +110054#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
Ben Lindstrom7ad97102000-12-06 01:42:49 +000055#define SSH_CHANNEL_CONNECTING 12
Ben Lindstrom3bb4f9d2001-04-08 18:30:26 +000056#define SSH_CHANNEL_DYNAMIC 13
Ben Lindstromc0dee1a2001-06-05 20:52:50 +000057#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
58#define SSH_CHANNEL_MAX_TYPE 15
Damien Millerd4a8b7e1999-10-27 13:42:43 +100059
Damien Miller36f8dd32001-11-12 11:04:54 +110060#define SSH_CHANNEL_PATH_LEN 256
Ben Lindstrom99c73b32001-05-05 04:09:47 +000061
Damien Millerad833b32000-08-23 10:46:23 +100062struct Channel;
63typedef struct Channel Channel;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100064
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000065typedef void channel_callback_fn(int, void *);
Damien Miller077b2382005-12-31 16:22:32 +110066typedef int channel_infilter_fn(struct Channel *, char *, int);
67typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
Damien Millerad833b32000-08-23 10:46:23 +100068
69struct Channel {
Damien Miller95def091999-11-25 00:26:21 +110070 int type; /* channel type/state */
71 int self; /* my own channel identifier */
72 int remote_id; /* channel identifier for remote peer */
Damien Millerabea8ee2002-01-22 23:27:11 +110073 u_int istate; /* input from channel (state of receive half) */
74 u_int ostate; /* output to channel (state of transmit half) */
Damien Miller33b13562000-04-04 14:38:59 +100075 int flags; /* close sent/rcvd */
Damien Millerb38eff82000-04-01 11:09:21 +100076 int rfd; /* read fd */
77 int wfd; /* write fd */
78 int efd; /* extended fd */
79 int sock; /* sock fd */
Damien Miller0e220db2004-06-15 10:34:08 +100080 int ctl_fd; /* control fd (client sharing) */
Damien Miller79438cc2001-02-16 12:34:57 +110081 int isatty; /* rfd is a tty */
Ben Lindstrombeb5f332002-07-22 15:28:53 +000082 int wfd_isatty; /* wfd is a tty */
Darren Tucker5d78de62004-11-05 20:35:44 +110083 int client_tty; /* (client) TTY has been requested */
Damien Miller4623a752001-10-10 15:03:58 +100084 int force_drain; /* force close on iEOF */
85 int delayed; /* fdset hack */
Damien Miller95def091999-11-25 00:26:21 +110086 Buffer input; /* data read from socket, to be sent over
87 * encrypted connection */
88 Buffer output; /* data received over encrypted connection for
89 * send on socket */
Damien Millerb38eff82000-04-01 11:09:21 +100090 Buffer extended;
Ben Lindstrom99c73b32001-05-05 04:09:47 +000091 char path[SSH_CHANNEL_PATH_LEN];
92 /* path for unix domain sockets, or host name for forwards */
Damien Miller95def091999-11-25 00:26:21 +110093 int listening_port; /* port being listened for forwards */
94 int host_port; /* remote port to connect for forwards */
95 char *remote_name; /* remote hostname */
Damien Millerb38eff82000-04-01 11:09:21 +100096
Ben Lindstrom4fed2be2002-06-25 23:17:36 +000097 u_int remote_window;
98 u_int remote_maxpacket;
99 u_int local_window;
100 u_int local_window_max;
101 u_int local_consumed;
102 u_int local_maxpacket;
Damien Millerb38eff82000-04-01 11:09:21 +1000103 int extended_usage;
Damien Millere7378562001-12-21 14:58:35 +1100104 int single_connection;
Damien Millerb38eff82000-04-01 11:09:21 +1000105
106 char *ctype; /* type */
107
Damien Millere247cc42000-05-07 12:03:14 +1000108 /* callback */
Damien Miller67f0bc02002-02-05 12:23:08 +1100109 channel_callback_fn *confirm;
Damien Miller0e220db2004-06-15 10:34:08 +1000110 void *confirm_ctx;
Damien Miller39eda6e2005-11-05 14:52:50 +1100111 channel_callback_fn *detach_user;
112 int detach_close;
Damien Millerad833b32000-08-23 10:46:23 +1000113
114 /* filter */
Damien Miller077b2382005-12-31 16:22:32 +1100115 channel_infilter_fn *input_filter;
116 channel_outfilter_fn *output_filter;
Damien Millerd27b9472005-12-13 19:29:02 +1100117
118 int datagram; /* keep boundaries */
Damien Millerad833b32000-08-23 10:46:23 +1000119};
Damien Millerb38eff82000-04-01 11:09:21 +1000120
121#define CHAN_EXTENDED_IGNORE 0
122#define CHAN_EXTENDED_READ 1
123#define CHAN_EXTENDED_WRITE 2
124
Damien Millere4340be2000-09-16 13:29:08 +1100125/* default window/packet sizes for tcp/x11-fwd-channel */
Damien Miller19a59452002-02-19 15:20:57 +1100126#define CHAN_SES_PACKET_DEFAULT (32*1024)
127#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
128#define CHAN_TCP_PACKET_DEFAULT (32*1024)
129#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
130#define CHAN_X11_PACKET_DEFAULT (16*1024)
131#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
Damien Millere4340be2000-09-16 13:29:08 +1100132
Ben Lindstrome9c99912001-06-09 00:41:05 +0000133/* possible input states */
Damien Millerabea8ee2002-01-22 23:27:11 +1100134#define CHAN_INPUT_OPEN 0
135#define CHAN_INPUT_WAIT_DRAIN 1
136#define CHAN_INPUT_WAIT_OCLOSE 2
137#define CHAN_INPUT_CLOSED 3
Damien Millere4340be2000-09-16 13:29:08 +1100138
Ben Lindstrome9c99912001-06-09 00:41:05 +0000139/* possible output states */
Damien Millerabea8ee2002-01-22 23:27:11 +1100140#define CHAN_OUTPUT_OPEN 0
141#define CHAN_OUTPUT_WAIT_DRAIN 1
142#define CHAN_OUTPUT_WAIT_IEOF 2
143#define CHAN_OUTPUT_CLOSED 3
Ben Lindstrome9c99912001-06-09 00:41:05 +0000144
145#define CHAN_CLOSE_SENT 0x01
146#define CHAN_CLOSE_RCVD 0x02
Ben Lindstromcf159442002-03-26 03:26:24 +0000147#define CHAN_EOF_SENT 0x04
148#define CHAN_EOF_RCVD 0x08
149
Damien Miller077b2382005-12-31 16:22:32 +1100150#define CHAN_RBUF 16*1024
151
Ben Lindstromcf159442002-03-26 03:26:24 +0000152/* check whether 'efd' is still in use */
153#define CHANNEL_EFD_INPUT_ACTIVE(c) \
154 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
155 (c->efd != -1 || \
156 buffer_len(&c->extended) > 0))
157#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
158 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
Darren Tuckerce377c32005-07-14 17:05:51 +1000159 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
Ben Lindstromcf159442002-03-26 03:26:24 +0000160 buffer_len(&c->extended) > 0))
Ben Lindstrome9c99912001-06-09 00:41:05 +0000161
Ben Lindstrome9c99912001-06-09 00:41:05 +0000162/* channel management */
163
Damien Millerd47c62a2005-12-13 19:33:57 +1100164Channel *channel_by_id(int);
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000165Channel *channel_lookup(int);
Ben Lindstrom4fed2be2002-06-25 23:17:36 +0000166Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
Damien Miller19a59452002-02-19 15:20:57 +1100167void channel_set_fds(int, int, int, int, int, int, u_int);
Ben Lindstrom809744e2001-07-04 05:26:06 +0000168void channel_free(Channel *);
169void channel_free_all(void);
Ben Lindstrom809744e2001-07-04 05:26:06 +0000170void channel_stop_listening(void);
Ben Lindstrome9c99912001-06-09 00:41:05 +0000171
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000172void channel_send_open(int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000173void channel_request_start(int, char *, int);
Damien Miller39eda6e2005-11-05 14:52:50 +1100174void channel_register_cleanup(int, channel_callback_fn *, int);
Damien Miller0e220db2004-06-15 10:34:08 +1000175void channel_register_confirm(int, channel_callback_fn *, void *);
Damien Miller077b2382005-12-31 16:22:32 +1100176void channel_register_filter(int, channel_infilter_fn *, channel_outfilter_fn *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000177void channel_cancel_cleanup(int);
Ben Lindstrom16d29d52001-07-18 16:01:46 +0000178int channel_close_fd(int *);
Damien Miller0e220db2004-06-15 10:34:08 +1000179void channel_send_window_changes(void);
Damien Millerb38eff82000-04-01 11:09:21 +1000180
Ben Lindstrome9c99912001-06-09 00:41:05 +0000181/* protocol handler */
Damien Millerb38eff82000-04-01 11:09:21 +1000182
Damien Miller630d6f42002-01-22 23:17:30 +1100183void channel_input_close(int, u_int32_t, void *);
184void channel_input_close_confirmation(int, u_int32_t, void *);
185void channel_input_data(int, u_int32_t, void *);
186void channel_input_extended_data(int, u_int32_t, void *);
187void channel_input_ieof(int, u_int32_t, void *);
188void channel_input_oclose(int, u_int32_t, void *);
189void channel_input_open_confirmation(int, u_int32_t, void *);
190void channel_input_open_failure(int, u_int32_t, void *);
191void channel_input_port_open(int, u_int32_t, void *);
192void channel_input_window_adjust(int, u_int32_t, void *);
Damien Millerb38eff82000-04-01 11:09:21 +1000193
Ben Lindstrome9c99912001-06-09 00:41:05 +0000194/* file descriptor handling (read/write) */
Damien Millerb38eff82000-04-01 11:09:21 +1000195
Darren Tuckerc7a6fc42004-08-13 21:18:00 +1000196void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000197void channel_after_select(fd_set *, fd_set *);
198void channel_output_poll(void);
Damien Millerb38eff82000-04-01 11:09:21 +1000199
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000200int channel_not_very_much_buffered_data(void);
201void channel_close_all(void);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000202int channel_still_open(void);
203char *channel_open_message(void);
204int channel_find_open(void);
Damien Millerb38eff82000-04-01 11:09:21 +1000205
Ben Lindstrom908afed2001-10-03 17:34:59 +0000206/* tcp forwarding */
207void channel_set_af(int af);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000208void channel_permit_all_opens(void);
209void channel_add_permitted_opens(char *, int);
210void channel_clear_permitted_opens(void);
211void channel_input_port_forward_request(int, int);
212int channel_connect_to(const char *, u_short);
Ben Lindstrom173e6462001-07-04 05:15:15 +0000213int channel_connect_by_listen_address(u_short);
Damien Millerf91ee4c2005-03-01 21:24:33 +1100214void channel_request_remote_forwarding(const char *, u_short,
215 const char *, u_short);
216int channel_setup_local_fwd_listener(const char *, u_short,
217 const char *, u_short, int);
218void channel_request_rforward_cancel(const char *host, u_short port);
Damien Millerb16461c2002-01-22 23:29:22 +1100219int channel_setup_remote_fwd_listener(const char *, u_short, int);
Darren Tuckere7066df2004-05-24 10:18:05 +1000220int channel_cancel_rport_listener(const char *, u_short);
Damien Millerb38eff82000-04-01 11:09:21 +1000221
Ben Lindstrome9c99912001-06-09 00:41:05 +0000222/* x11 forwarding */
223
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000224int x11_connect_display(void);
Damien Miller2b9b0452005-07-17 17:19:24 +1000225int x11_create_display_inet(int, int, int, u_int *, int **);
Damien Miller630d6f42002-01-22 23:17:30 +1100226void x11_input_open(int, u_int32_t, void *);
Damien Miller17e7ed02005-06-17 12:54:33 +1000227void x11_request_forwarding_with_spoofing(int, const char *, const char *,
228 const char *);
Damien Miller630d6f42002-01-22 23:17:30 +1100229void deny_input_open(int, u_int32_t, void *);
Damien Millerb38eff82000-04-01 11:09:21 +1000230
Ben Lindstrome9c99912001-06-09 00:41:05 +0000231/* agent forwarding */
232
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000233void auth_request_forwarding(void);
Damien Millerb38eff82000-04-01 11:09:21 +1000234
Ben Lindstrome9c99912001-06-09 00:41:05 +0000235/* channel close */
Damien Miller33b13562000-04-04 14:38:59 +1000236
Damien Miller3ec27592001-10-12 11:35:04 +1000237int chan_is_dead(Channel *, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000238void chan_mark_dead(Channel *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000239
Damien Miller5144df92002-01-22 23:28:45 +1100240/* channel events */
Ben Lindstrome9c99912001-06-09 00:41:05 +0000241
Damien Miller5144df92002-01-22 23:28:45 +1100242void chan_rcvd_oclose(Channel *);
243void chan_read_failed(Channel *);
244void chan_ibuf_empty(Channel *);
Ben Lindstrome9c99912001-06-09 00:41:05 +0000245
Damien Miller5144df92002-01-22 23:28:45 +1100246void chan_rcvd_ieof(Channel *);
247void chan_write_failed(Channel *);
248void chan_obuf_empty(Channel *);
Ben Lindstrome9c99912001-06-09 00:41:05 +0000249
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000250#endif