]> andersk Git - openssh.git/blame - channels.h
- (dtucker) [configure.ac misc.c readconf.c servconf.c ssh-keyscan.c]
[openssh.git] / channels.h
CommitLineData
7501ed0d 1/* $OpenBSD: channels.h,v 1.100 2009/11/11 21:37:03 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
2e73a022 58struct Channel;
59typedef struct Channel Channel;
60
2a1e4639 61typedef void channel_callback_fn(int, void *);
c1c6a032 62typedef int channel_infilter_fn(struct Channel *, char *, int);
e74caf1e 63typedef void channel_filter_cleanup_fn(int, void *);
c1c6a032 64typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
8efc0c15 65
3593bdc0 66/* Channel success/failure callbacks */
67typedef void channel_confirm_cb(int, struct Channel *, void *);
68typedef void channel_confirm_abandon_cb(struct Channel *, void *);
69struct channel_confirm {
70 TAILQ_ENTRY(channel_confirm) entry;
71 channel_confirm_cb *cb;
72 channel_confirm_abandon_cb *abandon_cb;
73 void *ctx;
74};
75TAILQ_HEAD(channel_confirms, channel_confirm);
76
e07e21ad 77/* Context for non-blocking connects */
78struct channel_connect {
79 char *host;
80 int port;
81 struct addrinfo *ai, *aitop;
82};
83
2e73a022 84struct Channel {
5260325f 85 int type; /* channel type/state */
86 int self; /* my own channel identifier */
87 int remote_id; /* channel identifier for remote peer */
368e9dfc 88 u_int istate; /* input from channel (state of receive half) */
89 u_int ostate; /* output to channel (state of transmit half) */
7e7327a1 90 int flags; /* close sent/rcvd */
7368a6c8 91 int rfd; /* read fd */
92 int wfd; /* write fd */
93 int efd; /* extended fd */
94 int sock; /* sock fd */
5e96b616 95 int ctl_fd; /* control fd (client sharing) */
0ae4fe1d 96 int isatty; /* rfd is a tty */
21c2c5cd 97 int wfd_isatty; /* wfd is a tty */
2c9a4d41 98 int client_tty; /* (client) TTY has been requested */
639cb8ab 99 int force_drain; /* force close on iEOF */
7501ed0d 100 int delayed; /* post-select handlers for newly created
101 * channels are delayed until the first call
102 * to a matching pre-select handler.
103 * this way post-select handlers are not
104 * accidenly called if a FD gets reused */
5260325f 105 Buffer input; /* data read from socket, to be sent over
106 * encrypted connection */
107 Buffer output; /* data received over encrypted connection for
108 * send on socket */
7368a6c8 109 Buffer extended;
1338ba77 110 char *path;
719fc62f 111 /* path for unix domain sockets, or host name for forwards */
5260325f 112 int listening_port; /* port being listened for forwards */
113 int host_port; /* remote port to connect for forwards */
114 char *remote_name; /* remote hostname */
7368a6c8 115
f91d9a89 116 u_int remote_window;
117 u_int remote_maxpacket;
118 u_int local_window;
119 u_int local_window_max;
120 u_int local_consumed;
121 u_int local_maxpacket;
7368a6c8 122 int extended_usage;
ac151b18 123 int single_connection;
7368a6c8 124
125 char *ctype; /* type */
126
1d1ffb87 127 /* callback */
3593bdc0 128 channel_callback_fn *open_confirm;
129 void *open_confirm_ctx;
8cd0437d 130 channel_callback_fn *detach_user;
131 int detach_close;
3593bdc0 132 struct channel_confirms status_confirms;
2e73a022 133
134 /* filter */
c1c6a032 135 channel_infilter_fn *input_filter;
136 channel_outfilter_fn *output_filter;
f17f705b 137 void *filter_ctx;
e74caf1e 138 channel_filter_cleanup_fn *filter_cleanup;
d20f3c9e 139
e07e21ad 140 /* keep boundaries */
141 int datagram;
142
143 /* non-blocking connect */
144 struct channel_connect connect_ctx;
2e73a022 145};
7368a6c8 146
147#define CHAN_EXTENDED_IGNORE 0
148#define CHAN_EXTENDED_READ 1
149#define CHAN_EXTENDED_WRITE 2
150
bcbf86ec 151/* default window/packet sizes for tcp/x11-fwd-channel */
ea9700ba 152#define CHAN_SES_PACKET_DEFAULT (32*1024)
e110afc3 153#define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT)
ea9700ba 154#define CHAN_TCP_PACKET_DEFAULT (32*1024)
e110afc3 155#define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT)
ea9700ba 156#define CHAN_X11_PACKET_DEFAULT (16*1024)
157#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
bcbf86ec 158
8e7895b8 159/* possible input states */
368e9dfc 160#define CHAN_INPUT_OPEN 0
161#define CHAN_INPUT_WAIT_DRAIN 1
162#define CHAN_INPUT_WAIT_OCLOSE 2
163#define CHAN_INPUT_CLOSED 3
bcbf86ec 164
8e7895b8 165/* possible output states */
368e9dfc 166#define CHAN_OUTPUT_OPEN 0
167#define CHAN_OUTPUT_WAIT_DRAIN 1
168#define CHAN_OUTPUT_WAIT_IEOF 2
169#define CHAN_OUTPUT_CLOSED 3
8e7895b8 170
171#define CHAN_CLOSE_SENT 0x01
172#define CHAN_CLOSE_RCVD 0x02
d2296ed7 173#define CHAN_EOF_SENT 0x04
174#define CHAN_EOF_RCVD 0x08
175
c1c6a032 176#define CHAN_RBUF 16*1024
177
d2296ed7 178/* check whether 'efd' is still in use */
179#define CHANNEL_EFD_INPUT_ACTIVE(c) \
180 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
181 (c->efd != -1 || \
182 buffer_len(&c->extended) > 0))
183#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
184 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
cee6ad3d 185 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
d2296ed7 186 buffer_len(&c->extended) > 0))
8e7895b8 187
8e7895b8 188/* channel management */
189
b872f7f0 190Channel *channel_by_id(int);
2a1e4639 191Channel *channel_lookup(int);
f91d9a89 192Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
c9478090 193void channel_set_fds(int, int, int, int, int, int, int, u_int);
3cf2be58 194void channel_free(Channel *);
195void channel_free_all(void);
3cf2be58 196void channel_stop_listening(void);
255cabd9 197
198void channel_send_open(int);
255cabd9 199void channel_request_start(int, char *, int);
8cd0437d 200void channel_register_cleanup(int, channel_callback_fn *, int);
3593bdc0 201void channel_register_open_confirm(int, channel_callback_fn *, void *);
202void channel_register_filter(int, channel_infilter_fn *,
e74caf1e 203 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *);
3593bdc0 204void channel_register_status_confirm(int, channel_confirm_cb *,
205 channel_confirm_abandon_cb *, void *);
255cabd9 206void channel_cancel_cleanup(int);
489aa2e9 207int channel_close_fd(int *);
5e96b616 208void channel_send_window_changes(void);
7368a6c8 209
8e7895b8 210/* protocol handler */
7368a6c8 211
7819b5c3 212void channel_input_close(int, u_int32_t, void *);
213void channel_input_close_confirmation(int, u_int32_t, void *);
214void channel_input_data(int, u_int32_t, void *);
215void channel_input_extended_data(int, u_int32_t, void *);
216void channel_input_ieof(int, u_int32_t, void *);
217void channel_input_oclose(int, u_int32_t, void *);
218void channel_input_open_confirmation(int, u_int32_t, void *);
219void channel_input_open_failure(int, u_int32_t, void *);
220void channel_input_port_open(int, u_int32_t, void *);
221void channel_input_window_adjust(int, u_int32_t, void *);
3593bdc0 222void channel_input_status_confirm(int, u_int32_t, void *);
7368a6c8 223
8e7895b8 224/* file descriptor handling (read/write) */
7368a6c8 225
9a995072 226void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
255cabd9 227void channel_after_select(fd_set *, fd_set *);
228void channel_output_poll(void);
7368a6c8 229
255cabd9 230int channel_not_very_much_buffered_data(void);
231void channel_close_all(void);
255cabd9 232int channel_still_open(void);
233char *channel_open_message(void);
234int channel_find_open(void);
7368a6c8 235
5e4a7219 236/* tcp forwarding */
237void channel_set_af(int af);
fe7dba42 238void channel_set_rdomain(int);
255cabd9 239void channel_permit_all_opens(void);
240void channel_add_permitted_opens(char *, int);
ea46e550 241int channel_add_adm_permitted_opens(char *, int);
255cabd9 242void channel_clear_permitted_opens(void);
2fefbadf 243void channel_clear_adm_permitted_opens(void);
1760c982 244void channel_print_adm_permitted_opens(void);
42ea6f5e 245int channel_input_port_forward_request(int, int);
e07e21ad 246Channel *channel_connect_to(const char *, u_short, char *, char *);
247Channel *channel_connect_by_listen_address(u_short, char *, char *);
42ea6f5e 248int channel_request_remote_forwarding(const char *, u_short,
3867aa0a 249 const char *, u_short);
250int channel_setup_local_fwd_listener(const char *, u_short,
251 const char *, u_short, int);
252void channel_request_rforward_cancel(const char *host, u_short port);
17525a70 253int channel_setup_remote_fwd_listener(const char *, u_short, int *, int);
d740ec16 254int channel_cancel_rport_listener(const char *, u_short);
7368a6c8 255
8e7895b8 256/* x11 forwarding */
7368a6c8 257
255cabd9 258int x11_connect_display(void);
d08341e6 259int x11_create_display_inet(int, int, int, u_int *, int **);
7819b5c3 260void x11_input_open(int, u_int32_t, void *);
9bf083eb 261void x11_request_forwarding_with_spoofing(int, const char *, const char *,
e07e21ad 262 const char *);
7819b5c3 263void deny_input_open(int, u_int32_t, void *);
7368a6c8 264
8e7895b8 265/* agent forwarding */
7368a6c8 266
255cabd9 267void auth_request_forwarding(void);
7368a6c8 268
8e7895b8 269/* channel close */
7e7327a1 270
418e724c 271int chan_is_dead(Channel *, int);
255cabd9 272void chan_mark_dead(Channel *);
255cabd9 273
70bef40e 274/* channel events */
8e7895b8 275
70bef40e 276void chan_rcvd_oclose(Channel *);
50c96367 277void chan_rcvd_eow(Channel *); /* SSH2-only */
70bef40e 278void chan_read_failed(Channel *);
279void chan_ibuf_empty(Channel *);
8e7895b8 280
70bef40e 281void chan_rcvd_ieof(Channel *);
282void chan_write_failed(Channel *);
283void chan_obuf_empty(Channel *);
8e7895b8 284
8efc0c15 285#endif
This page took 2.5095 seconds and 5 git commands to generate.