]> andersk Git - openssh.git/blame - channels.h
- markus@cvs.openbsd.org 2008/05/09 16:17:51
[openssh.git] / channels.h
CommitLineData
e07e21ad 1/* $OpenBSD: channels.h,v 1.91 2008/05/09 04:55:56 djm Exp $ */
93c3b6de 2
bcbf86ec 3/*
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/*
8ab5f6b2 15 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
bcbf86ec 16 *
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 */
8efc0c15 37
8e7895b8 38#ifndef CHANNEL_H
39#define CHANNEL_H
8efc0c15 40
41/* Definitions for channel types. */
aa3378df 42#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
5260325f 43#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
44#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
45#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
aa3378df 46#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
7368a6c8 47#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
48#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
49#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
50#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
51#define SSH_CHANNEL_LARVAL 10 /* larval session */
fa08c86b 52#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
97fb6912 53#define SSH_CHANNEL_CONNECTING 12
0490e609 54#define SSH_CHANNEL_DYNAMIC 13
6fd8622b 55#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
56#define SSH_CHANNEL_MAX_TYPE 15
8efc0c15 57
27c47c0a 58#define SSH_CHANNEL_PATH_LEN 256
719fc62f 59
2e73a022 60struct Channel;
61typedef struct Channel Channel;
62
2a1e4639 63typedef void channel_callback_fn(int, void *);
c1c6a032 64typedef int channel_infilter_fn(struct Channel *, char *, int);
65typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
8efc0c15 66
3593bdc0 67/* Channel success/failure callbacks */
68typedef void channel_confirm_cb(int, struct Channel *, void *);
69typedef void channel_confirm_abandon_cb(struct Channel *, void *);
70struct channel_confirm {
71 TAILQ_ENTRY(channel_confirm) entry;
72 channel_confirm_cb *cb;
73 channel_confirm_abandon_cb *abandon_cb;
74 void *ctx;
75};
76TAILQ_HEAD(channel_confirms, channel_confirm);
77
e07e21ad 78/* Context for non-blocking connects */
79struct channel_connect {
80 char *host;
81 int port;
82 struct addrinfo *ai, *aitop;
83};
84
2e73a022 85struct Channel {
5260325f 86 int type; /* channel type/state */
87 int self; /* my own channel identifier */
88 int remote_id; /* channel identifier for remote peer */
368e9dfc 89 u_int istate; /* input from channel (state of receive half) */
90 u_int ostate; /* output to channel (state of transmit half) */
7e7327a1 91 int flags; /* close sent/rcvd */
7368a6c8 92 int rfd; /* read fd */
93 int wfd; /* write fd */
94 int efd; /* extended fd */
95 int sock; /* sock fd */
5e96b616 96 int ctl_fd; /* control fd (client sharing) */
0ae4fe1d 97 int isatty; /* rfd is a tty */
21c2c5cd 98 int wfd_isatty; /* wfd is a tty */
2c9a4d41 99 int client_tty; /* (client) TTY has been requested */
639cb8ab 100 int force_drain; /* force close on iEOF */
101 int delayed; /* fdset hack */
5260325f 102 Buffer input; /* data read from socket, to be sent over
103 * encrypted connection */
104 Buffer output; /* data received over encrypted connection for
105 * send on socket */
7368a6c8 106 Buffer extended;
719fc62f 107 char path[SSH_CHANNEL_PATH_LEN];
108 /* path for unix domain sockets, or host name for forwards */
5260325f 109 int listening_port; /* port being listened for forwards */
110 int host_port; /* remote port to connect for forwards */
111 char *remote_name; /* remote hostname */
7368a6c8 112
f91d9a89 113 u_int remote_window;
114 u_int remote_maxpacket;
115 u_int local_window;
116 u_int local_window_max;
117 u_int local_consumed;
118 u_int local_maxpacket;
7368a6c8 119 int extended_usage;
ac151b18 120 int single_connection;
7368a6c8 121
122 char *ctype; /* type */
123
1d1ffb87 124 /* callback */
3593bdc0 125 channel_callback_fn *open_confirm;
126 void *open_confirm_ctx;
8cd0437d 127 channel_callback_fn *detach_user;
128 int detach_close;
3593bdc0 129 struct channel_confirms status_confirms;
2e73a022 130
131 /* filter */
c1c6a032 132 channel_infilter_fn *input_filter;
133 channel_outfilter_fn *output_filter;
d20f3c9e 134
e07e21ad 135 /* keep boundaries */
136 int datagram;
137
138 /* non-blocking connect */
139 struct channel_connect connect_ctx;
2e73a022 140};
7368a6c8 141
142#define CHAN_EXTENDED_IGNORE 0
143#define CHAN_EXTENDED_READ 1
144#define CHAN_EXTENDED_WRITE 2
145
bcbf86ec 146/* default window/packet sizes for tcp/x11-fwd-channel */
ea9700ba 147#define CHAN_SES_PACKET_DEFAULT (32*1024)
e110afc3 148#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT)
ea9700ba 149#define CHAN_TCP_PACKET_DEFAULT (32*1024)
e110afc3 150#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT)
ea9700ba 151#define CHAN_X11_PACKET_DEFAULT (16*1024)
152#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
bcbf86ec 153
8e7895b8 154/* possible input states */
368e9dfc 155#define CHAN_INPUT_OPEN 0
156#define CHAN_INPUT_WAIT_DRAIN 1
157#define CHAN_INPUT_WAIT_OCLOSE 2
158#define CHAN_INPUT_CLOSED 3
bcbf86ec 159
8e7895b8 160/* possible output states */
368e9dfc 161#define CHAN_OUTPUT_OPEN 0
162#define CHAN_OUTPUT_WAIT_DRAIN 1
163#define CHAN_OUTPUT_WAIT_IEOF 2
164#define CHAN_OUTPUT_CLOSED 3
8e7895b8 165
166#define CHAN_CLOSE_SENT 0x01
167#define CHAN_CLOSE_RCVD 0x02
d2296ed7 168#define CHAN_EOF_SENT 0x04
169#define CHAN_EOF_RCVD 0x08
170
c1c6a032 171#define CHAN_RBUF 16*1024
172
d2296ed7 173/* check whether 'efd' is still in use */
174#define CHANNEL_EFD_INPUT_ACTIVE(c) \
175 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
176 (c->efd != -1 || \
177 buffer_len(&c->extended) > 0))
178#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
179 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
cee6ad3d 180 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
d2296ed7 181 buffer_len(&c->extended) > 0))
8e7895b8 182
8e7895b8 183/* channel management */
184
b872f7f0 185Channel *channel_by_id(int);
2a1e4639 186Channel *channel_lookup(int);
f91d9a89 187Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
ea9700ba 188void channel_set_fds(int, int, int, int, int, int, u_int);
3cf2be58 189void channel_free(Channel *);
190void channel_free_all(void);
3cf2be58 191void channel_stop_listening(void);
255cabd9 192
193void channel_send_open(int);
255cabd9 194void channel_request_start(int, char *, int);
8cd0437d 195void channel_register_cleanup(int, channel_callback_fn *, int);
3593bdc0 196void channel_register_open_confirm(int, channel_callback_fn *, void *);
197void channel_register_filter(int, channel_infilter_fn *,
198 channel_outfilter_fn *);
199void channel_register_status_confirm(int, channel_confirm_cb *,
200 channel_confirm_abandon_cb *, void *);
255cabd9 201void channel_cancel_cleanup(int);
489aa2e9 202int channel_close_fd(int *);
5e96b616 203void channel_send_window_changes(void);
7368a6c8 204
8e7895b8 205/* protocol handler */
7368a6c8 206
7819b5c3 207void channel_input_close(int, u_int32_t, void *);
208void channel_input_close_confirmation(int, u_int32_t, void *);
209void channel_input_data(int, u_int32_t, void *);
210void channel_input_extended_data(int, u_int32_t, void *);
211void channel_input_ieof(int, u_int32_t, void *);
212void channel_input_oclose(int, u_int32_t, void *);
213void channel_input_open_confirmation(int, u_int32_t, void *);
214void channel_input_open_failure(int, u_int32_t, void *);
215void channel_input_port_open(int, u_int32_t, void *);
216void channel_input_window_adjust(int, u_int32_t, void *);
3593bdc0 217void channel_input_status_confirm(int, u_int32_t, void *);
7368a6c8 218
8e7895b8 219/* file descriptor handling (read/write) */
7368a6c8 220
9a995072 221void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
255cabd9 222void channel_after_select(fd_set *, fd_set *);
223void channel_output_poll(void);
7368a6c8 224
255cabd9 225int channel_not_very_much_buffered_data(void);
226void channel_close_all(void);
255cabd9 227int channel_still_open(void);
228char *channel_open_message(void);
229int channel_find_open(void);
7368a6c8 230
5e4a7219 231/* tcp forwarding */
232void channel_set_af(int af);
255cabd9 233void channel_permit_all_opens(void);
234void channel_add_permitted_opens(char *, int);
ea46e550 235int channel_add_adm_permitted_opens(char *, int);
255cabd9 236void channel_clear_permitted_opens(void);
2fefbadf 237void channel_clear_adm_permitted_opens(void);
42ea6f5e 238int channel_input_port_forward_request(int, int);
e07e21ad 239Channel *channel_connect_to(const char *, u_short, char *, char *);
240Channel *channel_connect_by_listen_address(u_short, char *, char *);
42ea6f5e 241int channel_request_remote_forwarding(const char *, u_short,
3867aa0a 242 const char *, u_short);
243int channel_setup_local_fwd_listener(const char *, u_short,
244 const char *, u_short, int);
245void channel_request_rforward_cancel(const char *host, u_short port);
5641aefa 246int channel_setup_remote_fwd_listener(const char *, u_short, int);
d740ec16 247int channel_cancel_rport_listener(const char *, u_short);
7368a6c8 248
8e7895b8 249/* x11 forwarding */
7368a6c8 250
255cabd9 251int x11_connect_display(void);
d08341e6 252int x11_create_display_inet(int, int, int, u_int *, int **);
7819b5c3 253void x11_input_open(int, u_int32_t, void *);
9bf083eb 254void x11_request_forwarding_with_spoofing(int, const char *, const char *,
e07e21ad 255 const char *);
7819b5c3 256void deny_input_open(int, u_int32_t, void *);
7368a6c8 257
8e7895b8 258/* agent forwarding */
7368a6c8 259
255cabd9 260void auth_request_forwarding(void);
7368a6c8 261
8e7895b8 262/* channel close */
7e7327a1 263
418e724c 264int chan_is_dead(Channel *, int);
255cabd9 265void chan_mark_dead(Channel *);
255cabd9 266
70bef40e 267/* channel events */
8e7895b8 268
70bef40e 269void chan_rcvd_oclose(Channel *);
270void chan_read_failed(Channel *);
271void chan_ibuf_empty(Channel *);
8e7895b8 272
70bef40e 273void chan_rcvd_ieof(Channel *);
274void chan_write_failed(Channel *);
275void chan_obuf_empty(Channel *);
8e7895b8 276
8efc0c15 277#endif
This page took 0.25062 seconds and 5 git commands to generate.