]> andersk Git - gssapi-openssh.git/blame - openssh/channels.h
merged OpenSSH 5.1p1 to trunk
[gssapi-openssh.git] / openssh / channels.h
CommitLineData
5156b1a1 1/* $OpenBSD: channels.h,v 1.96 2008/06/15 20:06:26 djm Exp $ */
473db5ab 2
3c0ef626 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/*
473db5ab 15 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
3c0ef626 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 */
3c0ef626 37
38#ifndef CHANNEL_H
39#define CHANNEL_H
40
3c0ef626 41/* Definitions for channel types. */
42#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
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 */
46#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
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 */
52#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
53#define SSH_CHANNEL_CONNECTING 12
54#define SSH_CHANNEL_DYNAMIC 13
55#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
56#define SSH_CHANNEL_MAX_TYPE 15
57
58#define SSH_CHANNEL_PATH_LEN 256
59
60struct Channel;
61typedef struct Channel Channel;
62
63typedef void channel_callback_fn(int, void *);
08822d99 64typedef int channel_infilter_fn(struct Channel *, char *, int);
5156b1a1 65typedef void channel_filter_cleanup_fn(int, void *);
08822d99 66typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
3c0ef626 67
5156b1a1 68/* Channel success/failure callbacks */
69typedef void channel_confirm_cb(int, struct Channel *, void *);
70typedef void channel_confirm_abandon_cb(struct Channel *, void *);
71struct channel_confirm {
72 TAILQ_ENTRY(channel_confirm) entry;
73 channel_confirm_cb *cb;
74 channel_confirm_abandon_cb *abandon_cb;
75 void *ctx;
76};
77TAILQ_HEAD(channel_confirms, channel_confirm);
78
79/* Context for non-blocking connects */
80struct channel_connect {
81 char *host;
82 int port;
83 struct addrinfo *ai, *aitop;
84};
85
3c0ef626 86struct Channel {
87 int type; /* channel type/state */
88 int self; /* my own channel identifier */
89 int remote_id; /* channel identifier for remote peer */
473db5ab 90 u_int istate; /* input from channel (state of receive half) */
91 u_int ostate; /* output to channel (state of transmit half) */
3c0ef626 92 int flags; /* close sent/rcvd */
93 int rfd; /* read fd */
94 int wfd; /* write fd */
95 int efd; /* extended fd */
96 int sock; /* sock fd */
473db5ab 97 int ctl_fd; /* control fd (client sharing) */
3c0ef626 98 int isatty; /* rfd is a tty */
473db5ab 99 int wfd_isatty; /* wfd is a tty */
100 int client_tty; /* (client) TTY has been requested */
3c0ef626 101 int force_drain; /* force close on iEOF */
102 int delayed; /* fdset hack */
103 Buffer input; /* data read from socket, to be sent over
104 * encrypted connection */
105 Buffer output; /* data received over encrypted connection for
106 * send on socket */
107 Buffer extended;
108 char path[SSH_CHANNEL_PATH_LEN];
109 /* path for unix domain sockets, or host name for forwards */
110 int listening_port; /* port being listened for forwards */
111 int host_port; /* remote port to connect for forwards */
112 char *remote_name; /* remote hostname */
113
473db5ab 114 u_int remote_window;
115 u_int remote_maxpacket;
116 u_int local_window;
117 u_int local_window_max;
118 u_int local_consumed;
119 u_int local_maxpacket;
120 int dynamic_window;
3c0ef626 121 int extended_usage;
473db5ab 122 int single_connection;
a7213e65 123 u_int tcpwinsz;
3c0ef626 124
125 char *ctype; /* type */
126
127 /* callback */
5156b1a1 128 channel_callback_fn *open_confirm;
129 void *open_confirm_ctx;
08822d99 130 channel_callback_fn *detach_user;
131 int detach_close;
5156b1a1 132 struct channel_confirms status_confirms;
3c0ef626 133
134 /* filter */
08822d99 135 channel_infilter_fn *input_filter;
136 channel_outfilter_fn *output_filter;
5156b1a1 137 void *filter_ctx;
138 channel_filter_cleanup_fn *filter_cleanup;
139
140 /* keep boundaries */
141 int datagram;
08822d99 142
5156b1a1 143 /* non-blocking connect */
144 struct channel_connect connect_ctx;
3c0ef626 145};
146
147#define CHAN_EXTENDED_IGNORE 0
148#define CHAN_EXTENDED_READ 1
149#define CHAN_EXTENDED_WRITE 2
150
151/* default window/packet sizes for tcp/x11-fwd-channel */
fa0f0f45 152#define CHAN_SES_PACKET_DEFAULT (32*1024)
4834571d 153#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
154
fa0f0f45 155#define CHAN_TCP_PACKET_DEFAULT (32*1024)
4834571d 156#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
157
fa0f0f45 158#define CHAN_X11_PACKET_DEFAULT (16*1024)
159#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
3c0ef626 160
161/* possible input states */
473db5ab 162#define CHAN_INPUT_OPEN 0
163#define CHAN_INPUT_WAIT_DRAIN 1
164#define CHAN_INPUT_WAIT_OCLOSE 2
165#define CHAN_INPUT_CLOSED 3
3c0ef626 166
167/* possible output states */
473db5ab 168#define CHAN_OUTPUT_OPEN 0
169#define CHAN_OUTPUT_WAIT_DRAIN 1
170#define CHAN_OUTPUT_WAIT_IEOF 2
171#define CHAN_OUTPUT_CLOSED 3
3c0ef626 172
173#define CHAN_CLOSE_SENT 0x01
174#define CHAN_CLOSE_RCVD 0x02
473db5ab 175#define CHAN_EOF_SENT 0x04
176#define CHAN_EOF_RCVD 0x08
177
08822d99 178#define CHAN_RBUF 16*1024
179
473db5ab 180/* check whether 'efd' is still in use */
181#define CHANNEL_EFD_INPUT_ACTIVE(c) \
182 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
183 (c->efd != -1 || \
184 buffer_len(&c->extended) > 0))
185#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
186 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
187 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
188 buffer_len(&c->extended) > 0))
3c0ef626 189
190/* channel management */
191
08822d99 192Channel *channel_by_id(int);
3c0ef626 193Channel *channel_lookup(int);
473db5ab 194Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
5156b1a1 195void channel_set_fds(int, int, int, int, int, int, int, u_int);
3c0ef626 196void channel_free(Channel *);
197void channel_free_all(void);
198void channel_stop_listening(void);
199
200void channel_send_open(int);
3c0ef626 201void channel_request_start(int, char *, int);
08822d99 202void channel_register_cleanup(int, channel_callback_fn *, int);
5156b1a1 203void channel_register_open_confirm(int, channel_callback_fn *, void *);
204void channel_register_filter(int, channel_infilter_fn *,
205 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *);
206void channel_register_status_confirm(int, channel_confirm_cb *,
207 channel_confirm_abandon_cb *, void *);
3c0ef626 208void channel_cancel_cleanup(int);
209int channel_close_fd(int *);
473db5ab 210void channel_send_window_changes(void);
3c0ef626 211
212/* protocol handler */
213
473db5ab 214void channel_input_close(int, u_int32_t, void *);
215void channel_input_close_confirmation(int, u_int32_t, void *);
216void channel_input_data(int, u_int32_t, void *);
217void channel_input_extended_data(int, u_int32_t, void *);
218void channel_input_ieof(int, u_int32_t, void *);
219void channel_input_oclose(int, u_int32_t, void *);
220void channel_input_open_confirmation(int, u_int32_t, void *);
221void channel_input_open_failure(int, u_int32_t, void *);
222void channel_input_port_open(int, u_int32_t, void *);
223void channel_input_window_adjust(int, u_int32_t, void *);
5156b1a1 224void channel_input_status_confirm(int, u_int32_t, void *);
3c0ef626 225
226/* file descriptor handling (read/write) */
227
473db5ab 228void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
3c0ef626 229void channel_after_select(fd_set *, fd_set *);
fa7499cc 230int channel_output_poll(void);
3c0ef626 231
232int channel_not_very_much_buffered_data(void);
233void channel_close_all(void);
234int channel_still_open(void);
235char *channel_open_message(void);
236int channel_find_open(void);
237
238/* tcp forwarding */
239void channel_set_af(int af);
240void channel_permit_all_opens(void);
241void channel_add_permitted_opens(char *, int);
30460aeb 242int channel_add_adm_permitted_opens(char *, int);
3c0ef626 243void channel_clear_permitted_opens(void);
30460aeb 244void channel_clear_adm_permitted_opens(void);
5156b1a1 245void channel_print_adm_permitted_opens(void);
30460aeb 246int channel_input_port_forward_request(int, int, int, int);
5156b1a1 247Channel *channel_connect_to(const char *, u_short, char *, char *);
248Channel *channel_connect_by_listen_address(u_short, char *, char *);
30460aeb 249int channel_request_remote_forwarding(const char *, u_short,
473db5ab 250 const char *, u_short);
251int channel_setup_local_fwd_listener(const char *, u_short,
a7213e65 252 const char *, u_short, int, int, int);
473db5ab 253void channel_request_rforward_cancel(const char *host, u_short port);
a7213e65 254int channel_setup_remote_fwd_listener(const char *, u_short, int, int, int);
473db5ab 255int channel_cancel_rport_listener(const char *, u_short);
3c0ef626 256
257/* x11 forwarding */
258
259int x11_connect_display(void);
a7213e65 260int x11_create_display_inet(int, int, int, u_int *, int **, int, int);
473db5ab 261void x11_input_open(int, u_int32_t, void *);
262void x11_request_forwarding_with_spoofing(int, const char *, const char *,
5156b1a1 263 const char *);
473db5ab 264void deny_input_open(int, u_int32_t, void *);
3c0ef626 265
266/* agent forwarding */
267
268void auth_request_forwarding(void);
3c0ef626 269
270/* channel close */
271
272int chan_is_dead(Channel *, int);
273void chan_mark_dead(Channel *);
3c0ef626 274
473db5ab 275/* channel events */
3c0ef626 276
473db5ab 277void chan_rcvd_oclose(Channel *);
5156b1a1 278void chan_rcvd_eow(Channel *); /* SSH2-only */
473db5ab 279void chan_read_failed(Channel *);
280void chan_ibuf_empty(Channel *);
3c0ef626 281
473db5ab 282void chan_rcvd_ieof(Channel *);
283void chan_write_failed(Channel *);
284void chan_obuf_empty(Channel *);
3c0ef626 285
286#endif
This page took 0.279727 seconds and 5 git commands to generate.