]> andersk Git - gssapi-openssh.git/blame - openssh/channels.h
NCSA_GSSAPI_20060726
[gssapi-openssh.git] / openssh / channels.h
CommitLineData
08822d99 1/* $OpenBSD: channels.h,v 1.83 2005/12/30 15:56:37 reyk 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
41#include "buffer.h"
42
43/* Definitions for channel types. */
44#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
45#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
46#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
47#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
48#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
49#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
50#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
51#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
52#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
53#define SSH_CHANNEL_LARVAL 10 /* larval session */
54#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
55#define SSH_CHANNEL_CONNECTING 12
56#define SSH_CHANNEL_DYNAMIC 13
57#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
58#define SSH_CHANNEL_MAX_TYPE 15
59
60#define SSH_CHANNEL_PATH_LEN 256
61
62struct Channel;
63typedef struct Channel Channel;
64
65typedef void channel_callback_fn(int, void *);
08822d99 66typedef int channel_infilter_fn(struct Channel *, char *, int);
67typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);
3c0ef626 68
69struct Channel {
70 int type; /* channel type/state */
71 int self; /* my own channel identifier */
72 int remote_id; /* channel identifier for remote peer */
473db5ab 73 u_int istate; /* input from channel (state of receive half) */
74 u_int ostate; /* output to channel (state of transmit half) */
3c0ef626 75 int flags; /* close sent/rcvd */
76 int rfd; /* read fd */
77 int wfd; /* write fd */
78 int efd; /* extended fd */
79 int sock; /* sock fd */
473db5ab 80 int ctl_fd; /* control fd (client sharing) */
3c0ef626 81 int isatty; /* rfd is a tty */
473db5ab 82 int wfd_isatty; /* wfd is a tty */
83 int client_tty; /* (client) TTY has been requested */
3c0ef626 84 int force_drain; /* force close on iEOF */
85 int delayed; /* fdset hack */
86 Buffer input; /* data read from socket, to be sent over
87 * encrypted connection */
88 Buffer output; /* data received over encrypted connection for
89 * send on socket */
90 Buffer extended;
91 char path[SSH_CHANNEL_PATH_LEN];
92 /* path for unix domain sockets, or host name for forwards */
93 int listening_port; /* port being listened for forwards */
94 int host_port; /* remote port to connect for forwards */
95 char *remote_name; /* remote hostname */
96
473db5ab 97 u_int remote_window;
98 u_int remote_maxpacket;
99 u_int local_window;
100 u_int local_window_max;
101 u_int local_consumed;
102 u_int local_maxpacket;
103 int dynamic_window;
3c0ef626 104 int extended_usage;
473db5ab 105 int single_connection;
a7213e65 106 u_int tcpwinsz;
3c0ef626 107
108 char *ctype; /* type */
109
110 /* callback */
473db5ab 111 channel_callback_fn *confirm;
473db5ab 112 void *confirm_ctx;
08822d99 113 channel_callback_fn *detach_user;
114 int detach_close;
3c0ef626 115
116 /* filter */
08822d99 117 channel_infilter_fn *input_filter;
118 channel_outfilter_fn *output_filter;
119
120 int datagram; /* keep boundaries */
3c0ef626 121};
122
123#define CHAN_EXTENDED_IGNORE 0
124#define CHAN_EXTENDED_READ 1
125#define CHAN_EXTENDED_WRITE 2
126
127/* default window/packet sizes for tcp/x11-fwd-channel */
a7213e65 128#define CHAN_SES_PACKET_DEFAULT (32*1024)
129#define CHAN_SES_WINDOW_DEFAULT_HPN (160*CHAN_TCP_PACKET_DEFAULT)
130#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
131
132#define CHAN_TCP_PACKET_DEFAULT (32*1024)
133#define CHAN_TCP_WINDOW_DEFAULT_HPN (160*CHAN_TCP_PACKET_DEFAULT)
134#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
135
136#define CHAN_X11_PACKET_DEFAULT (16*1024)
137#define CHAN_X11_WINDOW_DEFAULT_HPN (4*CHAN_X11_PACKET_DEFAULT)
138#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
3c0ef626 139
140/* possible input states */
473db5ab 141#define CHAN_INPUT_OPEN 0
142#define CHAN_INPUT_WAIT_DRAIN 1
143#define CHAN_INPUT_WAIT_OCLOSE 2
144#define CHAN_INPUT_CLOSED 3
3c0ef626 145
146/* possible output states */
473db5ab 147#define CHAN_OUTPUT_OPEN 0
148#define CHAN_OUTPUT_WAIT_DRAIN 1
149#define CHAN_OUTPUT_WAIT_IEOF 2
150#define CHAN_OUTPUT_CLOSED 3
3c0ef626 151
152#define CHAN_CLOSE_SENT 0x01
153#define CHAN_CLOSE_RCVD 0x02
473db5ab 154#define CHAN_EOF_SENT 0x04
155#define CHAN_EOF_RCVD 0x08
156
08822d99 157#define CHAN_RBUF 16*1024
158
473db5ab 159/* check whether 'efd' is still in use */
160#define CHANNEL_EFD_INPUT_ACTIVE(c) \
161 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
162 (c->efd != -1 || \
163 buffer_len(&c->extended) > 0))
164#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
165 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
166 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
167 buffer_len(&c->extended) > 0))
3c0ef626 168
169/* channel management */
170
08822d99 171Channel *channel_by_id(int);
3c0ef626 172Channel *channel_lookup(int);
473db5ab 173Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
174void channel_set_fds(int, int, int, int, int, int, u_int);
3c0ef626 175void channel_free(Channel *);
176void channel_free_all(void);
177void channel_stop_listening(void);
178
179void channel_send_open(int);
3c0ef626 180void channel_request_start(int, char *, int);
08822d99 181void channel_register_cleanup(int, channel_callback_fn *, int);
473db5ab 182void channel_register_confirm(int, channel_callback_fn *, void *);
08822d99 183void channel_register_filter(int, channel_infilter_fn *, channel_outfilter_fn *);
3c0ef626 184void channel_cancel_cleanup(int);
185int channel_close_fd(int *);
473db5ab 186void channel_send_window_changes(void);
3c0ef626 187
188/* protocol handler */
189
473db5ab 190void channel_input_close(int, u_int32_t, void *);
191void channel_input_close_confirmation(int, u_int32_t, void *);
192void channel_input_data(int, u_int32_t, void *);
193void channel_input_extended_data(int, u_int32_t, void *);
194void channel_input_ieof(int, u_int32_t, void *);
195void channel_input_oclose(int, u_int32_t, void *);
196void channel_input_open_confirmation(int, u_int32_t, void *);
197void channel_input_open_failure(int, u_int32_t, void *);
198void channel_input_port_open(int, u_int32_t, void *);
199void channel_input_window_adjust(int, u_int32_t, void *);
3c0ef626 200
201/* file descriptor handling (read/write) */
202
473db5ab 203void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
3c0ef626 204void channel_after_select(fd_set *, fd_set *);
205void channel_output_poll(void);
206
207int channel_not_very_much_buffered_data(void);
208void channel_close_all(void);
209int channel_still_open(void);
210char *channel_open_message(void);
211int channel_find_open(void);
212
213/* tcp forwarding */
214void channel_set_af(int af);
215void channel_permit_all_opens(void);
216void channel_add_permitted_opens(char *, int);
217void channel_clear_permitted_opens(void);
a7213e65 218void channel_input_port_forward_request(int, int, int, int);
3c0ef626 219int channel_connect_to(const char *, u_short);
220int channel_connect_by_listen_address(u_short);
473db5ab 221void channel_request_remote_forwarding(const char *, u_short,
222 const char *, u_short);
223int channel_setup_local_fwd_listener(const char *, u_short,
a7213e65 224 const char *, u_short, int, int, int);
473db5ab 225void channel_request_rforward_cancel(const char *host, u_short port);
a7213e65 226int channel_setup_remote_fwd_listener(const char *, u_short, int, int, int);
473db5ab 227int channel_cancel_rport_listener(const char *, u_short);
3c0ef626 228
229/* x11 forwarding */
230
231int x11_connect_display(void);
a7213e65 232int x11_create_display_inet(int, int, int, u_int *, int **, int, int);
473db5ab 233void x11_input_open(int, u_int32_t, void *);
234void x11_request_forwarding_with_spoofing(int, const char *, const char *,
235 const char *);
236void deny_input_open(int, u_int32_t, void *);
3c0ef626 237
238/* agent forwarding */
239
240void auth_request_forwarding(void);
3c0ef626 241
242/* channel close */
243
244int chan_is_dead(Channel *, int);
245void chan_mark_dead(Channel *);
3c0ef626 246
473db5ab 247/* channel events */
3c0ef626 248
473db5ab 249void chan_rcvd_oclose(Channel *);
250void chan_read_failed(Channel *);
251void chan_ibuf_empty(Channel *);
3c0ef626 252
473db5ab 253void chan_rcvd_ieof(Channel *);
254void chan_write_failed(Channel *);
255void chan_obuf_empty(Channel *);
3c0ef626 256
257#endif
This page took 0.09618 seconds and 5 git commands to generate.