]> andersk Git - openssh.git/blame - channels.h
- markus@cvs.openbsd.org 2001/04/06 21:00:17
[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 */
c422989b 35/* RCSID("$OpenBSD: channels.h,v 1.29 2001/04/04 20:25:36 markus Exp $"); */
8efc0c15 36
37#ifndef CHANNELS_H
38#define CHANNELS_H
39
01794848 40#include "buffer.h"
41
8efc0c15 42/* Definitions for channel types. */
aa3378df 43#define SSH_CHANNEL_FREE 0 /* This channel is free (unused). */
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
56#define SSH_CHANNEL_MAX_TYPE 13
8efc0c15 57
aa3378df 58/*
59 * Data structure for channel data. This is iniailized in channel_allocate
60 * and cleared in channel_free.
61 */
2e73a022 62struct Channel;
63typedef struct Channel Channel;
64
7368a6c8 65typedef void channel_callback_fn(int id, void *arg);
2e73a022 66typedef int channel_filter_fn(struct Channel *c, char *buf, int len);
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 */
72 /* peer can be reached over encrypted connection, via packet-sent */
73 int istate; /* input from channel (state of receive half) */
74 int ostate; /* output to channel (state of transmit half) */
7e7327a1 75 int flags; /* close sent/rcvd */
7368a6c8 76 int rfd; /* read fd */
77 int wfd; /* write fd */
78 int efd; /* extended fd */
79 int sock; /* sock fd */
0ae4fe1d 80 int isatty; /* rfd is a tty */
5260325f 81 Buffer input; /* data read from socket, to be sent over
82 * encrypted connection */
83 Buffer output; /* data received over encrypted connection for
84 * send on socket */
7368a6c8 85 Buffer extended;
5260325f 86 char path[200]; /* path for unix domain sockets, or host name
87 * for forwards */
88 int listening_port; /* port being listened for forwards */
89 int host_port; /* remote port to connect for forwards */
90 char *remote_name; /* remote hostname */
7368a6c8 91
92 int remote_window;
93 int remote_maxpacket;
94 int local_window;
95 int local_window_max;
96 int local_consumed;
97 int local_maxpacket;
98 int extended_usage;
99
100 char *ctype; /* type */
101
1d1ffb87 102 /* callback */
7368a6c8 103 channel_callback_fn *cb_fn;
104 void *cb_arg;
105 int cb_event;
106 channel_callback_fn *dettach_user;
2e73a022 107
108 /* filter */
109 channel_filter_fn *input_filter;
110};
7368a6c8 111
112#define CHAN_EXTENDED_IGNORE 0
113#define CHAN_EXTENDED_READ 1
114#define CHAN_EXTENDED_WRITE 2
115
bcbf86ec 116/* default window/packet sizes for tcp/x11-fwd-channel */
117#define CHAN_SES_WINDOW_DEFAULT (32*1024)
118#define CHAN_SES_PACKET_DEFAULT (CHAN_SES_WINDOW_DEFAULT/2)
119#define CHAN_TCP_WINDOW_DEFAULT (32*1024)
120#define CHAN_TCP_PACKET_DEFAULT (CHAN_TCP_WINDOW_DEFAULT/2)
121#define CHAN_X11_WINDOW_DEFAULT (4*1024)
122#define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2)
123
124
7368a6c8 125void channel_open(int id);
7e7327a1 126void channel_request(int id, char *service, int wantconfirm);
127void channel_request_start(int id, char *service, int wantconfirm);
128void channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg);
129void channel_register_cleanup(int id, channel_callback_fn *fn);
2e73a022 130void channel_register_filter(int id, channel_filter_fn *fn);
7e7327a1 131void channel_cancel_cleanup(int id);
7368a6c8 132Channel *channel_lookup(int id);
133
134int
135channel_new(char *ctype, int type, int rfd, int wfd, int efd,
a22aff1f 136 int window, int maxpack, int extended_usage, char *remote_name,
137 int nonblock);
138void
139channel_set_fds(int id, int rfd, int wfd, int efd,
140 int extusage, int nonblock);
141
142void deny_input_open(int type, int plen, void *ctxt);
7368a6c8 143
188adeb2 144void channel_input_channel_request(int type, int plen, void *ctxt);
145void channel_input_close(int type, int plen, void *ctxt);
146void channel_input_close_confirmation(int type, int plen, void *ctxt);
147void channel_input_data(int type, int plen, void *ctxt);
148void channel_input_extended_data(int type, int plen, void *ctxt);
149void channel_input_ieof(int type, int plen, void *ctxt);
150void channel_input_oclose(int type, int plen, void *ctxt);
151void channel_input_open_confirmation(int type, int plen, void *ctxt);
152void channel_input_open_failure(int type, int plen, void *ctxt);
153void channel_input_port_open(int type, int plen, void *ctxt);
154void channel_input_window_adjust(int type, int plen, void *ctxt);
7368a6c8 155
156/* Sets specific protocol options. */
157void channel_set_options(int hostname_in_open);
158
159/*
160 * Allocate a new channel object and set its type and socket. Remote_name
161 * must have been allocated with xmalloc; this will free it when the channel
162 * is freed.
163 */
164int channel_allocate(int type, int sock, char *remote_name);
165
166/* Free the channel and close its socket. */
167void channel_free(int channel);
168
39929cdb 169/*
170 * Allocate/update select bitmasks and add any bits relevant to channels in
171 * select bitmasks.
172 */
173void
c422989b 174channel_prepare_select(fd_set **readsetp, fd_set **writesetp, int *maxfdp,
175 int rekeying);
7368a6c8 176
177/*
178 * After select, perform any appropriate operations for channels which have
179 * events pending.
180 */
181void channel_after_select(fd_set * readset, fd_set * writeset);
182
183/* If there is data to send to the connection, send some of it now. */
184void channel_output_poll(void);
185
186/* Returns true if no channel has too much buffered data. */
187int channel_not_very_much_buffered_data(void);
188
189/* This closes any sockets that are listening for connections; this removes
190 any unix domain sockets. */
191void channel_stop_listening(void);
192
193/*
194 * Closes the sockets of all channels. This is used to close extra file
195 * descriptors after a fork.
196 */
197void channel_close_all(void);
198
7368a6c8 199/* Returns true if there is still an open channel over the connection. */
200int channel_still_open(void);
201
202/*
203 * Returns a string containing a list of all open channels. The list is
204 * suitable for displaying to the user. It uses crlf instead of newlines.
205 * The caller should free the string with xfree.
206 */
207char *channel_open_message(void);
208
209/*
210 * Initiate forwarding of connections to local port "port" through the secure
fa08c86b 211 * channel to host:port from remote side.
7368a6c8 212 */
02a024dd 213int
fa08c86b 214channel_request_local_forwarding(u_short listen_port,
215 const char *host_to_connect, u_short port_to_connect, int gateway_ports);
02a024dd 216int
fa08c86b 217channel_request_forwarding(const char *listen_address, u_short listen_port,
218 const char *host_to_connect, u_short port_to_connect, int gateway_ports,
219 int remote_fwd);
7368a6c8 220
221/*
222 * Initiate forwarding of connections to port "port" on remote host through
223 * the secure channel to host:port from local side. This never returns if
224 * there was an error. This registers that open requests for that port are
225 * permitted.
226 */
6ae2364d 227void
7368a6c8 228channel_request_remote_forwarding(u_short port, const char *host,
229 u_short remote_port);
230
231/*
01794848 232 * Permits opening to any host/port if permitted_opens[] is empty. This is
233 * usually called by the server, because the user could connect to any port
234 * anyway, and the server has no way to know but to trust the client anyway.
7368a6c8 235 */
236void channel_permit_all_opens(void);
237
01794848 238/* Add host/port to list of allowed targets for port forwarding */
239void channel_add_permitted_opens(char *host, int port);
240
241/* Flush list */
242void channel_clear_permitted_opens(void);
243
7368a6c8 244/*
245 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
246 * listening for the port, and sends back a success reply (or disconnect
247 * message if there was an error). This never returns if there was an error.
248 */
1d1ffb87 249void channel_input_port_forward_request(int is_root, int gateway_ports);
7368a6c8 250
251/*
252 * Creates a port for X11 connections, and starts listening for it. Returns
253 * the display name, or NULL if an error was encountered.
254 */
255char *x11_create_display(int screen);
256
257/*
258 * Creates an internet domain socket for listening for X11 connections.
259 * Returns a suitable value for the DISPLAY variable, or NULL if an error
260 * occurs.
261 */
262char *x11_create_display_inet(int screen, int x11_display_offset);
263
264/*
265 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
266 * the remote channel number. We should do whatever we want, and respond
267 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
268 */
188adeb2 269void x11_input_open(int type, int plen, void *ctxt);
7368a6c8 270
271/*
272 * Requests forwarding of X11 connections. This should be called on the
273 * client only.
274 */
275void x11_request_forwarding(void);
276
277/*
278 * Requests forwarding for X11 connections, with authentication spoofing.
279 * This should be called in the client only.
280 */
0b242b12 281void
282x11_request_forwarding_with_spoofing(int client_session_id,
283 const char *proto, const char *data);
7368a6c8 284
285/* Sends a message to the server to request authentication fd forwarding. */
286void auth_request_forwarding(void);
287
288/*
289 * Returns the name of the forwarded authentication socket. Returns NULL if
290 * there is no forwarded authentication socket. The returned value points to
291 * a static buffer.
292 */
293char *auth_get_socket_name(void);
294
295/*
fa649821 296 * This is called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
7368a6c8 297 * This starts forwarding authentication requests.
298 */
fa649821 299int auth_input_request_forwarding(struct passwd * pw);
7368a6c8 300
301/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
188adeb2 302void auth_input_open_request(int type, int plen, void *ctxt);
7368a6c8 303
7e7327a1 304/* XXX */
305int channel_connect_to(const char *host, u_short host_port);
fa08c86b 306int channel_connect_by_listen_adress(u_short listen_port);
0b242b12 307int x11_connect_display(void);
7e7327a1 308
8efc0c15 309#endif
This page took 0.31785 seconds and 5 git commands to generate.