]> andersk Git - openssh.git/blame - channels.h
- markus@cvs.openbsd.org 2001/03/16 13:44:24
[openssh.git] / channels.h
CommitLineData
bcbf86ec 1/*
2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
5 *
6 * As far as I am concerned, the code I have written for this software
7 * can be used freely for any purpose. Any derived versions of this
8 * software must be clearly marked as such, and if the derived work is
9 * incompatible with the protocol description in the RFC file, it must be
10 * called by a name other than "ssh" or "Secure Shell".
11 */
12/*
13 * Copyright (c) 2000 Markus Friedl. All rights reserved.
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
17 * are met:
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
0ae4fe1d 35/* RCSID("$OpenBSD: channels.h,v 1.27 2001/02/15 23:19:59 markus Exp $"); */
8efc0c15 36
37#ifndef CHANNELS_H
38#define CHANNELS_H
39
40/* Definitions for channel types. */
aa3378df 41#define SSH_CHANNEL_FREE 0 /* This channel is free (unused). */
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
54#define SSH_CHANNEL_MAX_TYPE 13
8efc0c15 55
aa3378df 56/*
57 * Data structure for channel data. This is iniailized in channel_allocate
58 * and cleared in channel_free.
59 */
2e73a022 60struct Channel;
61typedef struct Channel Channel;
62
7368a6c8 63typedef void channel_callback_fn(int id, void *arg);
2e73a022 64typedef int channel_filter_fn(struct Channel *c, char *buf, int len);
8efc0c15 65
2e73a022 66struct Channel {
5260325f 67 int type; /* channel type/state */
68 int self; /* my own channel identifier */
69 int remote_id; /* channel identifier for remote peer */
70 /* peer can be reached over encrypted connection, via packet-sent */
71 int istate; /* input from channel (state of receive half) */
72 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 */
0ae4fe1d 78 int isatty; /* rfd is a tty */
5260325f 79 Buffer input; /* data read from socket, to be sent over
80 * encrypted connection */
81 Buffer output; /* data received over encrypted connection for
82 * send on socket */
7368a6c8 83 Buffer extended;
5260325f 84 char path[200]; /* path for unix domain sockets, or host name
85 * for forwards */
86 int listening_port; /* port being listened for forwards */
87 int host_port; /* remote port to connect for forwards */
88 char *remote_name; /* remote hostname */
7368a6c8 89
90 int remote_window;
91 int remote_maxpacket;
92 int local_window;
93 int local_window_max;
94 int local_consumed;
95 int local_maxpacket;
96 int extended_usage;
97
98 char *ctype; /* type */
99
1d1ffb87 100 /* callback */
7368a6c8 101 channel_callback_fn *cb_fn;
102 void *cb_arg;
103 int cb_event;
104 channel_callback_fn *dettach_user;
2e73a022 105
106 /* filter */
107 channel_filter_fn *input_filter;
108};
7368a6c8 109
110#define CHAN_EXTENDED_IGNORE 0
111#define CHAN_EXTENDED_READ 1
112#define CHAN_EXTENDED_WRITE 2
113
bcbf86ec 114/* default window/packet sizes for tcp/x11-fwd-channel */
115#define CHAN_SES_WINDOW_DEFAULT (32*1024)
116#define CHAN_SES_PACKET_DEFAULT (CHAN_SES_WINDOW_DEFAULT/2)
117#define CHAN_TCP_WINDOW_DEFAULT (32*1024)
118#define CHAN_TCP_PACKET_DEFAULT (CHAN_TCP_WINDOW_DEFAULT/2)
119#define CHAN_X11_WINDOW_DEFAULT (4*1024)
120#define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2)
121
122
7368a6c8 123void channel_open(int id);
7e7327a1 124void channel_request(int id, char *service, int wantconfirm);
125void channel_request_start(int id, char *service, int wantconfirm);
126void channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg);
127void channel_register_cleanup(int id, channel_callback_fn *fn);
2e73a022 128void channel_register_filter(int id, channel_filter_fn *fn);
7e7327a1 129void channel_cancel_cleanup(int id);
7368a6c8 130Channel *channel_lookup(int id);
131
132int
133channel_new(char *ctype, int type, int rfd, int wfd, int efd,
a22aff1f 134 int window, int maxpack, int extended_usage, char *remote_name,
135 int nonblock);
136void
137channel_set_fds(int id, int rfd, int wfd, int efd,
138 int extusage, int nonblock);
139
140void deny_input_open(int type, int plen, void *ctxt);
7368a6c8 141
188adeb2 142void channel_input_channel_request(int type, int plen, void *ctxt);
143void channel_input_close(int type, int plen, void *ctxt);
144void channel_input_close_confirmation(int type, int plen, void *ctxt);
145void channel_input_data(int type, int plen, void *ctxt);
146void channel_input_extended_data(int type, int plen, void *ctxt);
147void channel_input_ieof(int type, int plen, void *ctxt);
148void channel_input_oclose(int type, int plen, void *ctxt);
149void channel_input_open_confirmation(int type, int plen, void *ctxt);
150void channel_input_open_failure(int type, int plen, void *ctxt);
151void channel_input_port_open(int type, int plen, void *ctxt);
152void channel_input_window_adjust(int type, int plen, void *ctxt);
7368a6c8 153
154/* Sets specific protocol options. */
155void channel_set_options(int hostname_in_open);
156
157/*
158 * Allocate a new channel object and set its type and socket. Remote_name
159 * must have been allocated with xmalloc; this will free it when the channel
160 * is freed.
161 */
162int channel_allocate(int type, int sock, char *remote_name);
163
164/* Free the channel and close its socket. */
165void channel_free(int channel);
166
39929cdb 167/*
168 * Allocate/update select bitmasks and add any bits relevant to channels in
169 * select bitmasks.
170 */
171void
172channel_prepare_select(fd_set **readsetp, fd_set **writesetp, int *maxfdp);
7368a6c8 173
174/*
175 * After select, perform any appropriate operations for channels which have
176 * events pending.
177 */
178void channel_after_select(fd_set * readset, fd_set * writeset);
179
180/* If there is data to send to the connection, send some of it now. */
181void channel_output_poll(void);
182
183/* Returns true if no channel has too much buffered data. */
184int channel_not_very_much_buffered_data(void);
185
186/* This closes any sockets that are listening for connections; this removes
187 any unix domain sockets. */
188void channel_stop_listening(void);
189
190/*
191 * Closes the sockets of all channels. This is used to close extra file
192 * descriptors after a fork.
193 */
194void channel_close_all(void);
195
7368a6c8 196/* Returns true if there is still an open channel over the connection. */
197int channel_still_open(void);
198
199/*
200 * Returns a string containing a list of all open channels. The list is
201 * suitable for displaying to the user. It uses crlf instead of newlines.
202 * The caller should free the string with xfree.
203 */
204char *channel_open_message(void);
205
206/*
207 * Initiate forwarding of connections to local port "port" through the secure
fa08c86b 208 * channel to host:port from remote side.
7368a6c8 209 */
02a024dd 210int
fa08c86b 211channel_request_local_forwarding(u_short listen_port,
212 const char *host_to_connect, u_short port_to_connect, int gateway_ports);
02a024dd 213int
fa08c86b 214channel_request_forwarding(const char *listen_address, u_short listen_port,
215 const char *host_to_connect, u_short port_to_connect, int gateway_ports,
216 int remote_fwd);
7368a6c8 217
218/*
219 * Initiate forwarding of connections to port "port" on remote host through
220 * the secure channel to host:port from local side. This never returns if
221 * there was an error. This registers that open requests for that port are
222 * permitted.
223 */
6ae2364d 224void
7368a6c8 225channel_request_remote_forwarding(u_short port, const char *host,
226 u_short remote_port);
227
228/*
229 * Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
230 * called by the server, because the user could connect to any port anyway,
231 * and the server has no way to know but to trust the client anyway.
232 */
233void channel_permit_all_opens(void);
234
235/*
236 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
237 * listening for the port, and sends back a success reply (or disconnect
238 * message if there was an error). This never returns if there was an error.
239 */
1d1ffb87 240void channel_input_port_forward_request(int is_root, int gateway_ports);
7368a6c8 241
242/*
243 * Creates a port for X11 connections, and starts listening for it. Returns
244 * the display name, or NULL if an error was encountered.
245 */
246char *x11_create_display(int screen);
247
248/*
249 * Creates an internet domain socket for listening for X11 connections.
250 * Returns a suitable value for the DISPLAY variable, or NULL if an error
251 * occurs.
252 */
253char *x11_create_display_inet(int screen, int x11_display_offset);
254
255/*
256 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
257 * the remote channel number. We should do whatever we want, and respond
258 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
259 */
188adeb2 260void x11_input_open(int type, int plen, void *ctxt);
7368a6c8 261
262/*
263 * Requests forwarding of X11 connections. This should be called on the
264 * client only.
265 */
266void x11_request_forwarding(void);
267
268/*
269 * Requests forwarding for X11 connections, with authentication spoofing.
270 * This should be called in the client only.
271 */
0b242b12 272void
273x11_request_forwarding_with_spoofing(int client_session_id,
274 const char *proto, const char *data);
7368a6c8 275
276/* Sends a message to the server to request authentication fd forwarding. */
277void auth_request_forwarding(void);
278
279/*
280 * Returns the name of the forwarded authentication socket. Returns NULL if
281 * there is no forwarded authentication socket. The returned value points to
282 * a static buffer.
283 */
284char *auth_get_socket_name(void);
285
286/*
fa649821 287 * This is called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
7368a6c8 288 * This starts forwarding authentication requests.
289 */
fa649821 290int auth_input_request_forwarding(struct passwd * pw);
7368a6c8 291
292/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
188adeb2 293void auth_input_open_request(int type, int plen, void *ctxt);
7368a6c8 294
7e7327a1 295/* XXX */
296int channel_connect_to(const char *host, u_short host_port);
fa08c86b 297int channel_connect_by_listen_adress(u_short listen_port);
0b242b12 298int x11_connect_display(void);
7e7327a1 299
8efc0c15 300#endif
This page took 0.387678 seconds and 5 git commands to generate.