]> andersk Git - openssh.git/blame - channels.h
- markus@cvs.openbsd.org 2008/05/08 06:59:01
[openssh.git] / channels.h
CommitLineData
e110afc3 1/* $OpenBSD: channels.h,v 1.89 2007/06/11 09:14:00 markus 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
2e73a022 67struct Channel {
5260325f 68 int type; /* channel type/state */
69 int self; /* my own channel identifier */
70 int remote_id; /* channel identifier for remote peer */
368e9dfc 71 u_int istate; /* input from channel (state of receive half) */
72 u_int ostate; /* output to channel (state of transmit half) */
7e7327a1 73 int flags; /* close sent/rcvd */
7368a6c8 74 int rfd; /* read fd */
75 int wfd; /* write fd */
76 int efd; /* extended fd */
77 int sock; /* sock fd */
5e96b616 78 int ctl_fd; /* control fd (client sharing) */
0ae4fe1d 79 int isatty; /* rfd is a tty */
21c2c5cd 80 int wfd_isatty; /* wfd is a tty */
2c9a4d41 81 int client_tty; /* (client) TTY has been requested */
639cb8ab 82 int force_drain; /* force close on iEOF */
83 int delayed; /* fdset hack */
5260325f 84 Buffer input; /* data read from socket, to be sent over
85 * encrypted connection */
86 Buffer output; /* data received over encrypted connection for
87 * send on socket */
7368a6c8 88 Buffer extended;
719fc62f 89 char path[SSH_CHANNEL_PATH_LEN];
90 /* path for unix domain sockets, or host name for forwards */
5260325f 91 int listening_port; /* port being listened for forwards */
92 int host_port; /* remote port to connect for forwards */
93 char *remote_name; /* remote hostname */
7368a6c8 94
f91d9a89 95 u_int remote_window;
96 u_int remote_maxpacket;
97 u_int local_window;
98 u_int local_window_max;
99 u_int local_consumed;
100 u_int local_maxpacket;
7368a6c8 101 int extended_usage;
ac151b18 102 int single_connection;
7368a6c8 103
104 char *ctype; /* type */
105
1d1ffb87 106 /* callback */
05ca0898 107 channel_callback_fn *confirm;
5e96b616 108 void *confirm_ctx;
8cd0437d 109 channel_callback_fn *detach_user;
110 int detach_close;
2e73a022 111
112 /* filter */
c1c6a032 113 channel_infilter_fn *input_filter;
114 channel_outfilter_fn *output_filter;
d20f3c9e 115
116 int datagram; /* keep boundaries */
2e73a022 117};
7368a6c8 118
119#define CHAN_EXTENDED_IGNORE 0
120#define CHAN_EXTENDED_READ 1
121#define CHAN_EXTENDED_WRITE 2
122
bcbf86ec 123/* default window/packet sizes for tcp/x11-fwd-channel */
ea9700ba 124#define CHAN_SES_PACKET_DEFAULT (32*1024)
e110afc3 125#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT)
ea9700ba 126#define CHAN_TCP_PACKET_DEFAULT (32*1024)
e110afc3 127#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT)
ea9700ba 128#define CHAN_X11_PACKET_DEFAULT (16*1024)
129#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
bcbf86ec 130
8e7895b8 131/* possible input states */
368e9dfc 132#define CHAN_INPUT_OPEN 0
133#define CHAN_INPUT_WAIT_DRAIN 1
134#define CHAN_INPUT_WAIT_OCLOSE 2
135#define CHAN_INPUT_CLOSED 3
bcbf86ec 136
8e7895b8 137/* possible output states */
368e9dfc 138#define CHAN_OUTPUT_OPEN 0
139#define CHAN_OUTPUT_WAIT_DRAIN 1
140#define CHAN_OUTPUT_WAIT_IEOF 2
141#define CHAN_OUTPUT_CLOSED 3
8e7895b8 142
143#define CHAN_CLOSE_SENT 0x01
144#define CHAN_CLOSE_RCVD 0x02
d2296ed7 145#define CHAN_EOF_SENT 0x04
146#define CHAN_EOF_RCVD 0x08
147
c1c6a032 148#define CHAN_RBUF 16*1024
149
d2296ed7 150/* check whether 'efd' is still in use */
151#define CHANNEL_EFD_INPUT_ACTIVE(c) \
152 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
153 (c->efd != -1 || \
154 buffer_len(&c->extended) > 0))
155#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
156 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
cee6ad3d 157 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
d2296ed7 158 buffer_len(&c->extended) > 0))
8e7895b8 159
8e7895b8 160/* channel management */
161
b872f7f0 162Channel *channel_by_id(int);
2a1e4639 163Channel *channel_lookup(int);
f91d9a89 164Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
ea9700ba 165void channel_set_fds(int, int, int, int, int, int, u_int);
3cf2be58 166void channel_free(Channel *);
167void channel_free_all(void);
3cf2be58 168void channel_stop_listening(void);
255cabd9 169
170void channel_send_open(int);
255cabd9 171void channel_request_start(int, char *, int);
8cd0437d 172void channel_register_cleanup(int, channel_callback_fn *, int);
5e96b616 173void channel_register_confirm(int, channel_callback_fn *, void *);
c1c6a032 174void channel_register_filter(int, channel_infilter_fn *, channel_outfilter_fn *);
255cabd9 175void channel_cancel_cleanup(int);
489aa2e9 176int channel_close_fd(int *);
5e96b616 177void channel_send_window_changes(void);
7368a6c8 178
8e7895b8 179/* protocol handler */
7368a6c8 180
7819b5c3 181void channel_input_close(int, u_int32_t, void *);
182void channel_input_close_confirmation(int, u_int32_t, void *);
183void channel_input_data(int, u_int32_t, void *);
184void channel_input_extended_data(int, u_int32_t, void *);
185void channel_input_ieof(int, u_int32_t, void *);
186void channel_input_oclose(int, u_int32_t, void *);
187void channel_input_open_confirmation(int, u_int32_t, void *);
188void channel_input_open_failure(int, u_int32_t, void *);
189void channel_input_port_open(int, u_int32_t, void *);
190void channel_input_window_adjust(int, u_int32_t, void *);
7368a6c8 191
8e7895b8 192/* file descriptor handling (read/write) */
7368a6c8 193
9a995072 194void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
255cabd9 195void channel_after_select(fd_set *, fd_set *);
196void channel_output_poll(void);
7368a6c8 197
255cabd9 198int channel_not_very_much_buffered_data(void);
199void channel_close_all(void);
255cabd9 200int channel_still_open(void);
201char *channel_open_message(void);
202int channel_find_open(void);
7368a6c8 203
5e4a7219 204/* tcp forwarding */
205void channel_set_af(int af);
255cabd9 206void channel_permit_all_opens(void);
207void channel_add_permitted_opens(char *, int);
ea46e550 208int channel_add_adm_permitted_opens(char *, int);
255cabd9 209void channel_clear_permitted_opens(void);
2fefbadf 210void channel_clear_adm_permitted_opens(void);
42ea6f5e 211int channel_input_port_forward_request(int, int);
255cabd9 212int channel_connect_to(const char *, u_short);
b3f8a79c 213int channel_connect_by_listen_address(u_short);
42ea6f5e 214int channel_request_remote_forwarding(const char *, u_short,
3867aa0a 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);
5641aefa 219int channel_setup_remote_fwd_listener(const char *, u_short, int);
d740ec16 220int channel_cancel_rport_listener(const char *, u_short);
7368a6c8 221
8e7895b8 222/* x11 forwarding */
7368a6c8 223
255cabd9 224int x11_connect_display(void);
d08341e6 225int x11_create_display_inet(int, int, int, u_int *, int **);
7819b5c3 226void x11_input_open(int, u_int32_t, void *);
9bf083eb 227void x11_request_forwarding_with_spoofing(int, const char *, const char *,
228 const char *);
7819b5c3 229void deny_input_open(int, u_int32_t, void *);
7368a6c8 230
8e7895b8 231/* agent forwarding */
7368a6c8 232
255cabd9 233void auth_request_forwarding(void);
7368a6c8 234
8e7895b8 235/* channel close */
7e7327a1 236
418e724c 237int chan_is_dead(Channel *, int);
255cabd9 238void chan_mark_dead(Channel *);
255cabd9 239
70bef40e 240/* channel events */
8e7895b8 241
70bef40e 242void chan_rcvd_oclose(Channel *);
243void chan_read_failed(Channel *);
244void chan_ibuf_empty(Channel *);
8e7895b8 245
70bef40e 246void chan_rcvd_ieof(Channel *);
247void chan_write_failed(Channel *);
248void chan_obuf_empty(Channel *);
8e7895b8 249
8efc0c15 250#endif
This page took 0.252814 seconds and 5 git commands to generate.