]> andersk Git - gssapi-openssh.git/blame - openssh/channels.h
The man2html from jbasney on pkilab2 works whereas the standard one doesn't.
[gssapi-openssh.git] / openssh / channels.h
CommitLineData
5262cbfb 1/* $OpenBSD: channels.h,v 1.98 2009/02/12 03:00:56 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
3c0ef626 58struct Channel;
59typedef struct Channel Channel;
60
61typedef void channel_callback_fn(int, void *);
08822d99 62typedef int channel_infilter_fn(struct Channel *, char *, int);
5156b1a1 63typedef void channel_filter_cleanup_fn(int, void *);
08822d99 64typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
3c0ef626 65
5156b1a1 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
77/* Context for non-blocking connects */
78struct channel_connect {
79 char *host;
80 int port;
81 struct addrinfo *ai, *aitop;
82};
83
3c0ef626 84struct Channel {
85 int type; /* channel type/state */
86 int self; /* my own channel identifier */
87 int remote_id; /* channel identifier for remote peer */
473db5ab 88 u_int istate; /* input from channel (state of receive half) */
89 u_int ostate; /* output to channel (state of transmit half) */
3c0ef626 90 int flags; /* close sent/rcvd */
91 int rfd; /* read fd */
92 int wfd; /* write fd */
93 int efd; /* extended fd */
94 int sock; /* sock fd */
473db5ab 95 int ctl_fd; /* control fd (client sharing) */
3c0ef626 96 int isatty; /* rfd is a tty */
473db5ab 97 int wfd_isatty; /* wfd is a tty */
98 int client_tty; /* (client) TTY has been requested */
3c0ef626 99 int force_drain; /* force close on iEOF */
100 int delayed; /* fdset hack */
101 Buffer input; /* data read from socket, to be sent over
102 * encrypted connection */
103 Buffer output; /* data received over encrypted connection for
104 * send on socket */
105 Buffer extended;
5262cbfb 106 char *path;
3c0ef626 107 /* path for unix domain sockets, or host name for forwards */
108 int listening_port; /* port being listened for forwards */
109 int host_port; /* remote port to connect for forwards */
110 char *remote_name; /* remote hostname */
111
473db5ab 112 u_int remote_window;
113 u_int remote_maxpacket;
114 u_int local_window;
115 u_int local_window_max;
116 u_int local_consumed;
117 u_int local_maxpacket;
118 int dynamic_window;
3c0ef626 119 int extended_usage;
473db5ab 120 int single_connection;
a7213e65 121 u_int tcpwinsz;
3c0ef626 122
123 char *ctype; /* type */
124
125 /* callback */
5156b1a1 126 channel_callback_fn *open_confirm;
127 void *open_confirm_ctx;
08822d99 128 channel_callback_fn *detach_user;
129 int detach_close;
5156b1a1 130 struct channel_confirms status_confirms;
3c0ef626 131
132 /* filter */
08822d99 133 channel_infilter_fn *input_filter;
134 channel_outfilter_fn *output_filter;
5156b1a1 135 void *filter_ctx;
136 channel_filter_cleanup_fn *filter_cleanup;
137
138 /* keep boundaries */
139 int datagram;
08822d99 140
5156b1a1 141 /* non-blocking connect */
142 struct channel_connect connect_ctx;
3c0ef626 143};
144
145#define CHAN_EXTENDED_IGNORE 0
146#define CHAN_EXTENDED_READ 1
147#define CHAN_EXTENDED_WRITE 2
148
149/* default window/packet sizes for tcp/x11-fwd-channel */
fa0f0f45 150#define CHAN_SES_PACKET_DEFAULT (32*1024)
4834571d 151#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
152
fa0f0f45 153#define CHAN_TCP_PACKET_DEFAULT (32*1024)
4834571d 154#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
155
fa0f0f45 156#define CHAN_X11_PACKET_DEFAULT (16*1024)
157#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
3c0ef626 158
159/* possible input states */
473db5ab 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
3c0ef626 164
165/* possible output states */
473db5ab 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
3c0ef626 170
171#define CHAN_CLOSE_SENT 0x01
172#define CHAN_CLOSE_RCVD 0x02
473db5ab 173#define CHAN_EOF_SENT 0x04
174#define CHAN_EOF_RCVD 0x08
175
08822d99 176#define CHAN_RBUF 16*1024
177
473db5ab 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 && \
185 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
186 buffer_len(&c->extended) > 0))
3c0ef626 187
188/* channel management */
189
08822d99 190Channel *channel_by_id(int);
3c0ef626 191Channel *channel_lookup(int);
473db5ab 192Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
5156b1a1 193void channel_set_fds(int, int, int, int, int, int, int, u_int);
3c0ef626 194void channel_free(Channel *);
195void channel_free_all(void);
196void channel_stop_listening(void);
197
198void channel_send_open(int);
3c0ef626 199void channel_request_start(int, char *, int);
08822d99 200void channel_register_cleanup(int, channel_callback_fn *, int);
5156b1a1 201void channel_register_open_confirm(int, channel_callback_fn *, void *);
202void channel_register_filter(int, channel_infilter_fn *,
203 channel_outfilter_fn *, channel_filter_cleanup_fn *, void *);
204void channel_register_status_confirm(int, channel_confirm_cb *,
205 channel_confirm_abandon_cb *, void *);
3c0ef626 206void channel_cancel_cleanup(int);
207int channel_close_fd(int *);
473db5ab 208void channel_send_window_changes(void);
3c0ef626 209
210/* protocol handler */
211
473db5ab 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 *);
5156b1a1 222void channel_input_status_confirm(int, u_int32_t, void *);
3c0ef626 223
224/* file descriptor handling (read/write) */
225
473db5ab 226void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
3c0ef626 227void channel_after_select(fd_set *, fd_set *);
fa7499cc 228int channel_output_poll(void);
3c0ef626 229
230int channel_not_very_much_buffered_data(void);
231void channel_close_all(void);
232int channel_still_open(void);
233char *channel_open_message(void);
234int channel_find_open(void);
235
236/* tcp forwarding */
237void channel_set_af(int af);
238void channel_permit_all_opens(void);
239void channel_add_permitted_opens(char *, int);
30460aeb 240int channel_add_adm_permitted_opens(char *, int);
3c0ef626 241void channel_clear_permitted_opens(void);
30460aeb 242void channel_clear_adm_permitted_opens(void);
5156b1a1 243void channel_print_adm_permitted_opens(void);
d3057ca4 244int channel_input_port_forward_request(int, int);
5156b1a1 245Channel *channel_connect_to(const char *, u_short, char *, char *);
246Channel *channel_connect_by_listen_address(u_short, char *, char *);
30460aeb 247int channel_request_remote_forwarding(const char *, u_short,
473db5ab 248 const char *, u_short);
249int channel_setup_local_fwd_listener(const char *, u_short,
d3057ca4 250 const char *, u_short, int);
473db5ab 251void channel_request_rforward_cancel(const char *host, u_short port);
5262cbfb 252int channel_setup_remote_fwd_listener(const char *, u_short, int *, int);
473db5ab 253int channel_cancel_rport_listener(const char *, u_short);
3c0ef626 254
255/* x11 forwarding */
256
257int x11_connect_display(void);
d3057ca4 258int x11_create_display_inet(int, int, int, u_int *, int **);
473db5ab 259void x11_input_open(int, u_int32_t, void *);
260void x11_request_forwarding_with_spoofing(int, const char *, const char *,
5156b1a1 261 const char *);
473db5ab 262void deny_input_open(int, u_int32_t, void *);
3c0ef626 263
264/* agent forwarding */
265
266void auth_request_forwarding(void);
3c0ef626 267
268/* channel close */
269
270int chan_is_dead(Channel *, int);
271void chan_mark_dead(Channel *);
3c0ef626 272
473db5ab 273/* channel events */
3c0ef626 274
473db5ab 275void chan_rcvd_oclose(Channel *);
5156b1a1 276void chan_rcvd_eow(Channel *); /* SSH2-only */
473db5ab 277void chan_read_failed(Channel *);
278void chan_ibuf_empty(Channel *);
3c0ef626 279
473db5ab 280void chan_rcvd_ieof(Channel *);
281void chan_write_failed(Channel *);
282void chan_obuf_empty(Channel *);
3c0ef626 283
d3057ca4 284/* hpn handler */
285void channel_set_hpn(int, int);
286
3c0ef626 287#endif
This page took 0.114091 seconds and 5 git commands to generate.