Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 1 | /* |
| 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 | /* |
Ben Lindstrom | 4469723 | 2001-07-04 03:32:30 +0000 | [diff] [blame] | 13 | * Copyright (c) 1999, 2000, 2001 Markus Friedl. All rights reserved. |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 14 | * |
| 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 | */ |
Ben Lindstrom | 944c4f0 | 2001-09-18 05:51:13 +0000 | [diff] [blame] | 35 | /* RCSID("$OpenBSD: channels.h,v 1.46 2001/09/17 20:52:47 markus Exp $"); */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 36 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 37 | #ifndef CHANNEL_H |
| 38 | #define CHANNEL_H |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 39 | |
Ben Lindstrom | 7bb8b49 | 2001-03-17 00:47:54 +0000 | [diff] [blame] | 40 | #include "buffer.h" |
| 41 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 42 | /* Definitions for channel types. */ |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 43 | #define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 44 | #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 Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 47 | #define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */ |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 48 | #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 Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 53 | #define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ |
Ben Lindstrom | 7ad9710 | 2000-12-06 01:42:49 +0000 | [diff] [blame] | 54 | #define SSH_CHANNEL_CONNECTING 12 |
Ben Lindstrom | 3bb4f9d | 2001-04-08 18:30:26 +0000 | [diff] [blame] | 55 | #define SSH_CHANNEL_DYNAMIC 13 |
Ben Lindstrom | c0dee1a | 2001-06-05 20:52:50 +0000 | [diff] [blame] | 56 | #define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ |
| 57 | #define SSH_CHANNEL_MAX_TYPE 15 |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 58 | |
Ben Lindstrom | 99c73b3 | 2001-05-05 04:09:47 +0000 | [diff] [blame] | 59 | #define SSH_CHANNEL_PATH_LEN 30 |
| 60 | |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 61 | struct Channel; |
| 62 | typedef struct Channel Channel; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 63 | |
Ben Lindstrom | 16ae3d0 | 2001-07-04 04:02:36 +0000 | [diff] [blame] | 64 | typedef void channel_callback_fn(int, void *); |
| 65 | typedef int channel_filter_fn(struct Channel *, char *, int); |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 66 | |
| 67 | struct Channel { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 68 | int type; /* channel type/state */ |
| 69 | int self; /* my own channel identifier */ |
| 70 | int remote_id; /* channel identifier for remote peer */ |
| 71 | /* peer can be reached over encrypted connection, via packet-sent */ |
| 72 | int istate; /* input from channel (state of receive half) */ |
| 73 | int ostate; /* output to channel (state of transmit half) */ |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame] | 74 | int flags; /* close sent/rcvd */ |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 75 | int rfd; /* read fd */ |
| 76 | int wfd; /* write fd */ |
| 77 | int efd; /* extended fd */ |
| 78 | int sock; /* sock fd */ |
Damien Miller | 79438cc | 2001-02-16 12:34:57 +1100 | [diff] [blame] | 79 | int isatty; /* rfd is a tty */ |
Ben Lindstrom | 944c4f0 | 2001-09-18 05:51:13 +0000 | [diff] [blame] | 80 | int force_drain; /* force close on iEOF */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 81 | 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 Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 85 | Buffer extended; |
Ben Lindstrom | 99c73b3 | 2001-05-05 04:09:47 +0000 | [diff] [blame] | 86 | char path[SSH_CHANNEL_PATH_LEN]; |
| 87 | /* path for unix domain sockets, or host name for forwards */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 88 | 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 Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 91 | |
| 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; |
| 99 | |
| 100 | char *ctype; /* type */ |
| 101 | |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 102 | /* callback */ |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 103 | channel_callback_fn *cb_fn; |
| 104 | void *cb_arg; |
| 105 | int cb_event; |
Ben Lindstrom | 809744e | 2001-07-04 05:26:06 +0000 | [diff] [blame] | 106 | channel_callback_fn *detach_user; |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 107 | |
| 108 | /* filter */ |
| 109 | channel_filter_fn *input_filter; |
| 110 | }; |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 111 | |
| 112 | #define CHAN_EXTENDED_IGNORE 0 |
| 113 | #define CHAN_EXTENDED_READ 1 |
| 114 | #define CHAN_EXTENDED_WRITE 2 |
| 115 | |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 116 | /* default window/packet sizes for tcp/x11-fwd-channel */ |
| 117 | #define CHAN_SES_WINDOW_DEFAULT (32*1024) |
| 118 | #define CHAN_SES_PACKET_DEFAULT (CHAN_SES_WINDOW_DEFAULT/2) |
| 119 | #define CHAN_TCP_WINDOW_DEFAULT (32*1024) |
| 120 | #define CHAN_TCP_PACKET_DEFAULT (CHAN_TCP_WINDOW_DEFAULT/2) |
| 121 | #define CHAN_X11_WINDOW_DEFAULT (4*1024) |
| 122 | #define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2) |
| 123 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 124 | /* possible input states */ |
| 125 | #define CHAN_INPUT_OPEN 0x01 |
| 126 | #define CHAN_INPUT_WAIT_DRAIN 0x02 |
| 127 | #define CHAN_INPUT_WAIT_OCLOSE 0x04 |
| 128 | #define CHAN_INPUT_CLOSED 0x08 |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 129 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 130 | /* possible output states */ |
| 131 | #define CHAN_OUTPUT_OPEN 0x10 |
| 132 | #define CHAN_OUTPUT_WAIT_DRAIN 0x20 |
| 133 | #define CHAN_OUTPUT_WAIT_IEOF 0x40 |
| 134 | #define CHAN_OUTPUT_CLOSED 0x80 |
| 135 | |
| 136 | #define CHAN_CLOSE_SENT 0x01 |
| 137 | #define CHAN_CLOSE_RCVD 0x02 |
| 138 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 139 | /* channel management */ |
| 140 | |
Ben Lindstrom | 16ae3d0 | 2001-07-04 04:02:36 +0000 | [diff] [blame] | 141 | Channel *channel_lookup(int); |
| 142 | Channel *channel_new(char *, int, int, int, int, int, int, int, char *, int); |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 143 | void channel_set_fds(int, int, int, int, int, int); |
Ben Lindstrom | 809744e | 2001-07-04 05:26:06 +0000 | [diff] [blame] | 144 | void channel_free(Channel *); |
| 145 | void channel_free_all(void); |
| 146 | void channel_detach_all(void); |
| 147 | void channel_stop_listening(void); |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 148 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 149 | void channel_send_open(int); |
| 150 | void channel_request(int, char *, int); |
| 151 | void channel_request_start(int, char *, int); |
| 152 | void channel_register_callback(int, int mtype, channel_callback_fn *, void *); |
| 153 | void channel_register_cleanup(int, channel_callback_fn *); |
| 154 | void channel_register_filter(int, channel_filter_fn *); |
| 155 | void channel_cancel_cleanup(int); |
Ben Lindstrom | 16d29d5 | 2001-07-18 16:01:46 +0000 | [diff] [blame] | 156 | int channel_close_fd(int *); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 157 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 158 | /* protocol handler */ |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 159 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 160 | void channel_input_channel_request(int, int, void *); |
| 161 | void channel_input_close(int, int, void *); |
| 162 | void channel_input_close_confirmation(int, int, void *); |
| 163 | void channel_input_data(int, int, void *); |
| 164 | void channel_input_extended_data(int, int, void *); |
| 165 | void channel_input_ieof(int, int, void *); |
| 166 | void channel_input_oclose(int, int, void *); |
| 167 | void channel_input_open_confirmation(int, int, void *); |
| 168 | void channel_input_open_failure(int, int, void *); |
| 169 | void channel_input_port_open(int, int, void *); |
| 170 | void channel_input_window_adjust(int, int, void *); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 171 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 172 | /* file descriptor handling (read/write) */ |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 173 | |
Ben Lindstrom | 16d29d5 | 2001-07-18 16:01:46 +0000 | [diff] [blame] | 174 | void channel_prepare_select(fd_set **, fd_set **, int *, int*, int); |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 175 | void channel_after_select(fd_set *, fd_set *); |
| 176 | void channel_output_poll(void); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 177 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 178 | int channel_not_very_much_buffered_data(void); |
| 179 | void channel_close_all(void); |
| 180 | void channel_free_all(void); |
| 181 | int channel_still_open(void); |
| 182 | char *channel_open_message(void); |
| 183 | int channel_find_open(void); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 184 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 185 | /* channel_tcpfwd.c */ |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 186 | void channel_permit_all_opens(void); |
| 187 | void channel_add_permitted_opens(char *, int); |
| 188 | void channel_clear_permitted_opens(void); |
| 189 | void channel_input_port_forward_request(int, int); |
| 190 | int channel_connect_to(const char *, u_short); |
Ben Lindstrom | 173e646 | 2001-07-04 05:15:15 +0000 | [diff] [blame] | 191 | int channel_connect_by_listen_address(u_short); |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 192 | void channel_request_remote_forwarding(u_short, const char *, u_short); |
| 193 | int channel_request_local_forwarding(u_short, const char *, u_short, int); |
Kevin Steves | 1205750 | 2001-02-05 14:54:34 +0000 | [diff] [blame] | 194 | int |
Ben Lindstrom | 16ae3d0 | 2001-07-04 04:02:36 +0000 | [diff] [blame] | 195 | channel_request_forwarding(const char *, u_short, const char *, u_short, int, |
| 196 | int); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 197 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 198 | /* x11 forwarding */ |
| 199 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 200 | int x11_connect_display(void); |
| 201 | char *x11_create_display(int); |
| 202 | char *x11_create_display_inet(int, int); |
| 203 | void x11_input_open(int, int, void *); |
| 204 | void x11_request_forwarding(void); |
| 205 | void x11_request_forwarding_with_spoofing(int, const char *, const char *); |
| 206 | void deny_input_open(int, int, void *); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 207 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 208 | /* agent forwarding */ |
| 209 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 210 | void auth_request_forwarding(void); |
| 211 | char *auth_get_socket_name(void); |
| 212 | void auth_sock_cleanup_proc(void *); |
| 213 | int auth_input_request_forwarding(struct passwd *); |
| 214 | void auth_input_open_request(int, int, void *); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 215 | |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 216 | /* channel close */ |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame] | 217 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 218 | int chan_is_dead(Channel *); |
| 219 | void chan_mark_dead(Channel *); |
| 220 | void chan_init_iostates(Channel *); |
| 221 | void chan_init(void); |
| 222 | |
Ben Lindstrom | 16ae3d0 | 2001-07-04 04:02:36 +0000 | [diff] [blame] | 223 | typedef void chan_event_fn(Channel *); |
Ben Lindstrom | e9c9991 | 2001-06-09 00:41:05 +0000 | [diff] [blame] | 224 | |
| 225 | /* for the input state */ |
| 226 | extern chan_event_fn *chan_rcvd_oclose; |
| 227 | extern chan_event_fn *chan_read_failed; |
| 228 | extern chan_event_fn *chan_ibuf_empty; |
| 229 | |
| 230 | /* for the output state */ |
| 231 | extern chan_event_fn *chan_rcvd_ieof; |
| 232 | extern chan_event_fn *chan_write_failed; |
| 233 | extern chan_event_fn *chan_obuf_empty; |
| 234 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 235 | #endif |