]> andersk Git - openssh.git/blame - channels.h
- reyk@cvs.openbsd.org 2005/12/06 22:38:28
[openssh.git] / channels.h
CommitLineData
d20f3c9e 1/* $OpenBSD: channels.h,v 1.81 2005/12/06 22:38:27 reyk 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
01794848 41#include "buffer.h"
42
8efc0c15 43/* Definitions for channel types. */
aa3378df 44#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
5260325f 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 */
aa3378df 48#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
7368a6c8 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 */
fa08c86b 54#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
97fb6912 55#define SSH_CHANNEL_CONNECTING 12
0490e609 56#define SSH_CHANNEL_DYNAMIC 13
6fd8622b 57#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
58#define SSH_CHANNEL_MAX_TYPE 15
8efc0c15 59
27c47c0a 60#define SSH_CHANNEL_PATH_LEN 256
719fc62f 61
2e73a022 62struct Channel;
63typedef struct Channel Channel;
64
2a1e4639 65typedef void channel_callback_fn(int, void *);
66typedef int channel_filter_fn(struct Channel *, char *, int);
8efc0c15 67
2e73a022 68struct Channel {
5260325f 69 int type; /* channel type/state */
70 int self; /* my own channel identifier */
71 int remote_id; /* channel identifier for remote peer */
368e9dfc 72 u_int istate; /* input from channel (state of receive half) */
73 u_int ostate; /* output to channel (state of transmit half) */
7e7327a1 74 int flags; /* close sent/rcvd */
7368a6c8 75 int rfd; /* read fd */
76 int wfd; /* write fd */
77 int efd; /* extended fd */
78 int sock; /* sock fd */
5e96b616 79 int ctl_fd; /* control fd (client sharing) */
0ae4fe1d 80 int isatty; /* rfd is a tty */
21c2c5cd 81 int wfd_isatty; /* wfd is a tty */
2c9a4d41 82 int client_tty; /* (client) TTY has been requested */
639cb8ab 83 int force_drain; /* force close on iEOF */
84 int delayed; /* fdset hack */
5260325f 85 Buffer input; /* data read from socket, to be sent over
86 * encrypted connection */
87 Buffer output; /* data received over encrypted connection for
88 * send on socket */
7368a6c8 89 Buffer extended;
719fc62f 90 char path[SSH_CHANNEL_PATH_LEN];
91 /* path for unix domain sockets, or host name for forwards */
5260325f 92 int listening_port; /* port being listened for forwards */
93 int host_port; /* remote port to connect for forwards */
94 char *remote_name; /* remote hostname */
7368a6c8 95
f91d9a89 96 u_int remote_window;
97 u_int remote_maxpacket;
98 u_int local_window;
99 u_int local_window_max;
100 u_int local_consumed;
101 u_int local_maxpacket;
7368a6c8 102 int extended_usage;
ac151b18 103 int single_connection;
7368a6c8 104
105 char *ctype; /* type */
106
1d1ffb87 107 /* callback */
05ca0898 108 channel_callback_fn *confirm;
5e96b616 109 void *confirm_ctx;
8cd0437d 110 channel_callback_fn *detach_user;
111 int detach_close;
2e73a022 112
113 /* filter */
114 channel_filter_fn *input_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)
125#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT)
126#define CHAN_TCP_PACKET_DEFAULT (32*1024)
127#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT)
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
148/* check whether 'efd' is still in use */
149#define CHANNEL_EFD_INPUT_ACTIVE(c) \
150 (compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
151 (c->efd != -1 || \
152 buffer_len(&c->extended) > 0))
153#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
154 (compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
cee6ad3d 155 c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
d2296ed7 156 buffer_len(&c->extended) > 0))
8e7895b8 157
8e7895b8 158/* channel management */
159
2a1e4639 160Channel *channel_lookup(int);
f91d9a89 161Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
ea9700ba 162void channel_set_fds(int, int, int, int, int, int, u_int);
3cf2be58 163void channel_free(Channel *);
164void channel_free_all(void);
3cf2be58 165void channel_stop_listening(void);
255cabd9 166
167void channel_send_open(int);
255cabd9 168void channel_request_start(int, char *, int);
8cd0437d 169void channel_register_cleanup(int, channel_callback_fn *, int);
5e96b616 170void channel_register_confirm(int, channel_callback_fn *, void *);
255cabd9 171void channel_register_filter(int, channel_filter_fn *);
172void channel_cancel_cleanup(int);
489aa2e9 173int channel_close_fd(int *);
5e96b616 174void channel_send_window_changes(void);
7368a6c8 175
8e7895b8 176/* protocol handler */
7368a6c8 177
7819b5c3 178void channel_input_close(int, u_int32_t, void *);
179void channel_input_close_confirmation(int, u_int32_t, void *);
180void channel_input_data(int, u_int32_t, void *);
181void channel_input_extended_data(int, u_int32_t, void *);
182void channel_input_ieof(int, u_int32_t, void *);
183void channel_input_oclose(int, u_int32_t, void *);
184void channel_input_open_confirmation(int, u_int32_t, void *);
185void channel_input_open_failure(int, u_int32_t, void *);
186void channel_input_port_open(int, u_int32_t, void *);
187void channel_input_window_adjust(int, u_int32_t, void *);
7368a6c8 188
8e7895b8 189/* file descriptor handling (read/write) */
7368a6c8 190
9a995072 191void channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
255cabd9 192void channel_after_select(fd_set *, fd_set *);
193void channel_output_poll(void);
7368a6c8 194
255cabd9 195int channel_not_very_much_buffered_data(void);
196void channel_close_all(void);
255cabd9 197int channel_still_open(void);
198char *channel_open_message(void);
199int channel_find_open(void);
7368a6c8 200
5e4a7219 201/* tcp forwarding */
202void channel_set_af(int af);
255cabd9 203void channel_permit_all_opens(void);
204void channel_add_permitted_opens(char *, int);
205void channel_clear_permitted_opens(void);
206void channel_input_port_forward_request(int, int);
207int channel_connect_to(const char *, u_short);
b3f8a79c 208int channel_connect_by_listen_address(u_short);
3867aa0a 209void channel_request_remote_forwarding(const char *, u_short,
210 const char *, u_short);
211int channel_setup_local_fwd_listener(const char *, u_short,
212 const char *, u_short, int);
213void channel_request_rforward_cancel(const char *host, u_short port);
5641aefa 214int channel_setup_remote_fwd_listener(const char *, u_short, int);
d740ec16 215int channel_cancel_rport_listener(const char *, u_short);
7368a6c8 216
8e7895b8 217/* x11 forwarding */
7368a6c8 218
255cabd9 219int x11_connect_display(void);
d08341e6 220int x11_create_display_inet(int, int, int, u_int *, int **);
7819b5c3 221void x11_input_open(int, u_int32_t, void *);
9bf083eb 222void x11_request_forwarding_with_spoofing(int, const char *, const char *,
223 const char *);
7819b5c3 224void deny_input_open(int, u_int32_t, void *);
7368a6c8 225
8e7895b8 226/* agent forwarding */
7368a6c8 227
255cabd9 228void auth_request_forwarding(void);
7368a6c8 229
8e7895b8 230/* channel close */
7e7327a1 231
418e724c 232int chan_is_dead(Channel *, int);
255cabd9 233void chan_mark_dead(Channel *);
255cabd9 234
70bef40e 235/* channel events */
8e7895b8 236
70bef40e 237void chan_rcvd_oclose(Channel *);
238void chan_read_failed(Channel *);
239void chan_ibuf_empty(Channel *);
8e7895b8 240
70bef40e 241void chan_rcvd_ieof(Channel *);
242void chan_write_failed(Channel *);
243void chan_obuf_empty(Channel *);
8e7895b8 244
8efc0c15 245#endif
This page took 0.797275 seconds and 5 git commands to generate.