blob: b637ab32c5f39a7f53f4aecc4aca682b2ef42e11 [file] [log] [blame]
Damien Millere4340be2000-09-16 13:29:08 +11001/*
2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
5 *
6 * As far as I am concerned, the code I have written for this software
7 * can be used freely for any purpose. Any derived versions of this
8 * software must be clearly marked as such, and if the derived work is
9 * incompatible with the protocol description in the RFC file, it must be
10 * called by a name other than "ssh" or "Secure Shell".
11 */
12/*
Damien Millerb51ed392002-01-22 23:29:03 +110013 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110014 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
17 * are met:
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
Damien Miller19a59452002-02-19 15:20:57 +110035/* RCSID("$OpenBSD: channels.h,v 1.64 2002/02/14 23:28:00 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100036
Ben Lindstrome9c99912001-06-09 00:41:05 +000037#ifndef CHANNEL_H
38#define CHANNEL_H
Damien Millerd4a8b7e1999-10-27 13:42:43 +100039
Ben Lindstrom7bb8b492001-03-17 00:47:54 +000040#include "buffer.h"
41
Damien Millerd4a8b7e1999-10-27 13:42:43 +100042/* Definitions for channel types. */
Damien Miller5428f641999-11-25 11:54:57 +110043#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
Damien Miller95def091999-11-25 00:26:21 +110044#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 */
Damien Miller5428f641999-11-25 11:54:57 +110047#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
Damien Millerb38eff82000-04-01 11:09:21 +100048#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 */
Damien Miller0bc1bd82000-11-13 22:57:25 +110053#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
Ben Lindstrom7ad97102000-12-06 01:42:49 +000054#define SSH_CHANNEL_CONNECTING 12
Ben Lindstrom3bb4f9d2001-04-08 18:30:26 +000055#define SSH_CHANNEL_DYNAMIC 13
Ben Lindstromc0dee1a2001-06-05 20:52:50 +000056#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
57#define SSH_CHANNEL_MAX_TYPE 15
Damien Millerd4a8b7e1999-10-27 13:42:43 +100058
Damien Miller36f8dd32001-11-12 11:04:54 +110059#define SSH_CHANNEL_PATH_LEN 256
Ben Lindstrom99c73b32001-05-05 04:09:47 +000060
Damien Millerad833b32000-08-23 10:46:23 +100061struct Channel;
62typedef struct Channel Channel;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100063
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000064typedef void channel_callback_fn(int, void *);
65typedef int channel_filter_fn(struct Channel *, char *, int);
Damien Millerad833b32000-08-23 10:46:23 +100066
67struct Channel {
Damien Miller95def091999-11-25 00:26:21 +110068 int type; /* channel type/state */
69 int self; /* my own channel identifier */
70 int remote_id; /* channel identifier for remote peer */
Damien Millerabea8ee2002-01-22 23:27:11 +110071 u_int istate; /* input from channel (state of receive half) */
72 u_int ostate; /* output to channel (state of transmit half) */
Damien Miller33b13562000-04-04 14:38:59 +100073 int flags; /* close sent/rcvd */
Damien Millerb38eff82000-04-01 11:09:21 +100074 int rfd; /* read fd */
75 int wfd; /* write fd */
76 int efd; /* extended fd */
77 int sock; /* sock fd */
Damien Miller79438cc2001-02-16 12:34:57 +110078 int isatty; /* rfd is a tty */
Damien Miller4623a752001-10-10 15:03:58 +100079 int force_drain; /* force close on iEOF */
80 int delayed; /* fdset hack */
Damien Miller95def091999-11-25 00:26:21 +110081 Buffer input; /* data read from socket, to be sent over
82 * encrypted connection */
83 Buffer output; /* data received over encrypted connection for
84 * send on socket */
Damien Millerb38eff82000-04-01 11:09:21 +100085 Buffer extended;
Ben Lindstrom99c73b32001-05-05 04:09:47 +000086 char path[SSH_CHANNEL_PATH_LEN];
87 /* path for unix domain sockets, or host name for forwards */
Damien Miller95def091999-11-25 00:26:21 +110088 int listening_port; /* port being listened for forwards */
89 int host_port; /* remote port to connect for forwards */
90 char *remote_name; /* remote hostname */
Damien Millerb38eff82000-04-01 11:09:21 +100091
92 int remote_window;
93 int remote_maxpacket;
94 int local_window;
95 int local_window_max;
96 int local_consumed;
97 int local_maxpacket;
98 int extended_usage;
Damien Millere7378562001-12-21 14:58:35 +110099 int single_connection;
Damien Millerb38eff82000-04-01 11:09:21 +1000100
101 char *ctype; /* type */
102
Damien Millere247cc42000-05-07 12:03:14 +1000103 /* callback */
Damien Miller67f0bc02002-02-05 12:23:08 +1100104 channel_callback_fn *confirm;
Ben Lindstrom809744e2001-07-04 05:26:06 +0000105 channel_callback_fn *detach_user;
Damien Millerad833b32000-08-23 10:46:23 +1000106
107 /* filter */
108 channel_filter_fn *input_filter;
109};
Damien Millerb38eff82000-04-01 11:09:21 +1000110
111#define CHAN_EXTENDED_IGNORE 0
112#define CHAN_EXTENDED_READ 1
113#define CHAN_EXTENDED_WRITE 2
114
Damien Millere4340be2000-09-16 13:29:08 +1100115/* default window/packet sizes for tcp/x11-fwd-channel */
Damien Miller19a59452002-02-19 15:20:57 +1100116#define CHAN_SES_PACKET_DEFAULT (32*1024)
117#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
118#define CHAN_TCP_PACKET_DEFAULT (32*1024)
119#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
120#define CHAN_X11_PACKET_DEFAULT (16*1024)
121#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
Damien Millere4340be2000-09-16 13:29:08 +1100122
Ben Lindstrome9c99912001-06-09 00:41:05 +0000123/* possible input states */
Damien Millerabea8ee2002-01-22 23:27:11 +1100124#define CHAN_INPUT_OPEN 0
125#define CHAN_INPUT_WAIT_DRAIN 1
126#define CHAN_INPUT_WAIT_OCLOSE 2
127#define CHAN_INPUT_CLOSED 3
Damien Millere4340be2000-09-16 13:29:08 +1100128
Ben Lindstrome9c99912001-06-09 00:41:05 +0000129/* possible output states */
Damien Millerabea8ee2002-01-22 23:27:11 +1100130#define CHAN_OUTPUT_OPEN 0
131#define CHAN_OUTPUT_WAIT_DRAIN 1
132#define CHAN_OUTPUT_WAIT_IEOF 2
133#define CHAN_OUTPUT_CLOSED 3
Ben Lindstrome9c99912001-06-09 00:41:05 +0000134
135#define CHAN_CLOSE_SENT 0x01
136#define CHAN_CLOSE_RCVD 0x02
137
Ben Lindstrome9c99912001-06-09 00:41:05 +0000138/* channel management */
139
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000140Channel *channel_lookup(int);
141Channel *channel_new(char *, int, int, int, int, int, int, int, char *, int);
Damien Miller19a59452002-02-19 15:20:57 +1100142void channel_set_fds(int, int, int, int, int, int, u_int);
Ben Lindstrom809744e2001-07-04 05:26:06 +0000143void channel_free(Channel *);
144void channel_free_all(void);
Ben Lindstrom809744e2001-07-04 05:26:06 +0000145void channel_stop_listening(void);
Ben Lindstrome9c99912001-06-09 00:41:05 +0000146
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000147void channel_send_open(int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000148void channel_request_start(int, char *, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000149void channel_register_cleanup(int, channel_callback_fn *);
Damien Miller67f0bc02002-02-05 12:23:08 +1100150void channel_register_confirm(int, channel_callback_fn *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000151void channel_register_filter(int, channel_filter_fn *);
152void channel_cancel_cleanup(int);
Ben Lindstrom16d29d52001-07-18 16:01:46 +0000153int channel_close_fd(int *);
Damien Millerb38eff82000-04-01 11:09:21 +1000154
Ben Lindstrome9c99912001-06-09 00:41:05 +0000155/* protocol handler */
Damien Millerb38eff82000-04-01 11:09:21 +1000156
Damien Miller630d6f42002-01-22 23:17:30 +1100157void channel_input_close(int, u_int32_t, void *);
158void channel_input_close_confirmation(int, u_int32_t, void *);
159void channel_input_data(int, u_int32_t, void *);
160void channel_input_extended_data(int, u_int32_t, void *);
161void channel_input_ieof(int, u_int32_t, void *);
162void channel_input_oclose(int, u_int32_t, void *);
163void channel_input_open_confirmation(int, u_int32_t, void *);
164void channel_input_open_failure(int, u_int32_t, void *);
165void channel_input_port_open(int, u_int32_t, void *);
166void channel_input_window_adjust(int, u_int32_t, void *);
Damien Millerb38eff82000-04-01 11:09:21 +1000167
Ben Lindstrome9c99912001-06-09 00:41:05 +0000168/* file descriptor handling (read/write) */
Damien Millerb38eff82000-04-01 11:09:21 +1000169
Ben Lindstrom16d29d52001-07-18 16:01:46 +0000170void channel_prepare_select(fd_set **, fd_set **, int *, int*, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000171void channel_after_select(fd_set *, fd_set *);
172void channel_output_poll(void);
Damien Millerb38eff82000-04-01 11:09:21 +1000173
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000174int channel_not_very_much_buffered_data(void);
175void channel_close_all(void);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000176int channel_still_open(void);
177char *channel_open_message(void);
178int channel_find_open(void);
Damien Millerb38eff82000-04-01 11:09:21 +1000179
Ben Lindstrom908afed2001-10-03 17:34:59 +0000180/* tcp forwarding */
181void channel_set_af(int af);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000182void channel_permit_all_opens(void);
183void channel_add_permitted_opens(char *, int);
184void channel_clear_permitted_opens(void);
185void channel_input_port_forward_request(int, int);
186int channel_connect_to(const char *, u_short);
Ben Lindstrom173e6462001-07-04 05:15:15 +0000187int channel_connect_by_listen_address(u_short);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000188void channel_request_remote_forwarding(u_short, const char *, u_short);
Damien Millerb16461c2002-01-22 23:29:22 +1100189int channel_setup_local_fwd_listener(u_short, const char *, u_short, int);
190int channel_setup_remote_fwd_listener(const char *, u_short, int);
Damien Millerb38eff82000-04-01 11:09:21 +1000191
Ben Lindstrome9c99912001-06-09 00:41:05 +0000192/* x11 forwarding */
193
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000194int x11_connect_display(void);
Damien Millere7378562001-12-21 14:58:35 +1100195int x11_create_display_inet(int, int, int);
Damien Miller630d6f42002-01-22 23:17:30 +1100196void x11_input_open(int, u_int32_t, void *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000197void x11_request_forwarding_with_spoofing(int, const char *, const char *);
Damien Miller630d6f42002-01-22 23:17:30 +1100198void deny_input_open(int, u_int32_t, void *);
Damien Millerb38eff82000-04-01 11:09:21 +1000199
Ben Lindstrome9c99912001-06-09 00:41:05 +0000200/* agent forwarding */
201
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000202void auth_request_forwarding(void);
203char *auth_get_socket_name(void);
204void auth_sock_cleanup_proc(void *);
205int auth_input_request_forwarding(struct passwd *);
Damien Miller630d6f42002-01-22 23:17:30 +1100206void auth_input_open_request(int, u_int32_t, void *);
Damien Millerb38eff82000-04-01 11:09:21 +1000207
Ben Lindstrome9c99912001-06-09 00:41:05 +0000208/* channel close */
Damien Miller33b13562000-04-04 14:38:59 +1000209
Damien Miller3ec27592001-10-12 11:35:04 +1000210int chan_is_dead(Channel *, int);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000211void chan_mark_dead(Channel *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000212
Damien Miller5144df92002-01-22 23:28:45 +1100213/* channel events */
Ben Lindstrome9c99912001-06-09 00:41:05 +0000214
Damien Miller5144df92002-01-22 23:28:45 +1100215void chan_rcvd_oclose(Channel *);
216void chan_read_failed(Channel *);
217void chan_ibuf_empty(Channel *);
Ben Lindstrome9c99912001-06-09 00:41:05 +0000218
Damien Miller5144df92002-01-22 23:28:45 +1100219void chan_rcvd_ieof(Channel *);
220void chan_write_failed(Channel *);
221void chan_obuf_empty(Channel *);
Ben Lindstrome9c99912001-06-09 00:41:05 +0000222
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000223#endif