blob: 9acdf5810e16e2cd52721fb73adc5b51af1fdd22 [file] [log] [blame]
Damien Millerad833b32000-08-23 10:46:23 +10001/* RCSID("$OpenBSD: channels.h,v 1.16 2000/08/19 21:55:51 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +10002
3#ifndef CHANNELS_H
4#define CHANNELS_H
5
6/* Definitions for channel types. */
Damien Miller5428f641999-11-25 11:54:57 +11007#define SSH_CHANNEL_FREE 0 /* This channel is free (unused). */
8#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
Damien Miller95def091999-11-25 00:26:21 +11009#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
10#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
11#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
Damien Miller5428f641999-11-25 11:54:57 +110012#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
Damien Millerb38eff82000-04-01 11:09:21 +100013#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
14#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
15#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
16#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
17#define SSH_CHANNEL_LARVAL 10 /* larval session */
18#define SSH_CHANNEL_MAX_TYPE 11
Damien Millerd4a8b7e1999-10-27 13:42:43 +100019
Damien Miller5428f641999-11-25 11:54:57 +110020/*
21 * Data structure for channel data. This is iniailized in channel_allocate
22 * and cleared in channel_free.
23 */
Damien Millerad833b32000-08-23 10:46:23 +100024struct Channel;
25typedef struct Channel Channel;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100026
Damien Millerad833b32000-08-23 10:46:23 +100027typedef void channel_callback_fn(int id, void *arg);
28typedef int channel_filter_fn(struct Channel *c, char *buf, int len);
29
30struct Channel {
Damien Miller95def091999-11-25 00:26:21 +110031 int type; /* channel type/state */
32 int self; /* my own channel identifier */
33 int remote_id; /* channel identifier for remote peer */
34 /* peer can be reached over encrypted connection, via packet-sent */
35 int istate; /* input from channel (state of receive half) */
36 int ostate; /* output to channel (state of transmit half) */
Damien Miller33b13562000-04-04 14:38:59 +100037 int flags; /* close sent/rcvd */
Damien Millerb38eff82000-04-01 11:09:21 +100038 int rfd; /* read fd */
39 int wfd; /* write fd */
40 int efd; /* extended fd */
41 int sock; /* sock fd */
Damien Miller95def091999-11-25 00:26:21 +110042 Buffer input; /* data read from socket, to be sent over
43 * encrypted connection */
44 Buffer output; /* data received over encrypted connection for
45 * send on socket */
Damien Millerb38eff82000-04-01 11:09:21 +100046 Buffer extended;
Damien Miller95def091999-11-25 00:26:21 +110047 char path[200]; /* path for unix domain sockets, or host name
48 * for forwards */
49 int listening_port; /* port being listened for forwards */
50 int host_port; /* remote port to connect for forwards */
51 char *remote_name; /* remote hostname */
Damien Millerb38eff82000-04-01 11:09:21 +100052
53 int remote_window;
54 int remote_maxpacket;
55 int local_window;
56 int local_window_max;
57 int local_consumed;
58 int local_maxpacket;
59 int extended_usage;
60
61 char *ctype; /* type */
62
Damien Millere247cc42000-05-07 12:03:14 +100063 /* callback */
Damien Millerb38eff82000-04-01 11:09:21 +100064 channel_callback_fn *cb_fn;
65 void *cb_arg;
66 int cb_event;
67 channel_callback_fn *dettach_user;
Damien Millerad833b32000-08-23 10:46:23 +100068
69 /* filter */
70 channel_filter_fn *input_filter;
71};
Damien Millerb38eff82000-04-01 11:09:21 +100072
73#define CHAN_EXTENDED_IGNORE 0
74#define CHAN_EXTENDED_READ 1
75#define CHAN_EXTENDED_WRITE 2
76
Damien Miller33b13562000-04-04 14:38:59 +100077void channel_set_fds(int id, int rfd, int wfd, int efd, int extusage);
Damien Millerb38eff82000-04-01 11:09:21 +100078void channel_open(int id);
Damien Miller33b13562000-04-04 14:38:59 +100079void channel_request(int id, char *service, int wantconfirm);
80void channel_request_start(int id, char *service, int wantconfirm);
81void channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg);
82void channel_register_cleanup(int id, channel_callback_fn *fn);
Damien Millerad833b32000-08-23 10:46:23 +100083void channel_register_filter(int id, channel_filter_fn *fn);
Damien Miller33b13562000-04-04 14:38:59 +100084void channel_cancel_cleanup(int id);
Damien Millerb38eff82000-04-01 11:09:21 +100085Channel *channel_lookup(int id);
86
87int
88channel_new(char *ctype, int type, int rfd, int wfd, int efd,
89 int window, int maxpack, int extended_usage, char *remote_name);
90
Damien Miller33b13562000-04-04 14:38:59 +100091void channel_input_channel_request(int type, int plen);
Damien Millerb38eff82000-04-01 11:09:21 +100092void channel_input_close(int type, int plen);
93void channel_input_close_confirmation(int type, int plen);
94void channel_input_data(int type, int plen);
Damien Miller33b13562000-04-04 14:38:59 +100095void channel_input_extended_data(int type, int plen);
Damien Millerb38eff82000-04-01 11:09:21 +100096void channel_input_ieof(int type, int plen);
97void channel_input_oclose(int type, int plen);
98void channel_input_open_confirmation(int type, int plen);
99void channel_input_open_failure(int type, int plen);
100void channel_input_port_open(int type, int plen);
Damien Miller33b13562000-04-04 14:38:59 +1000101void channel_input_window_adjust(int type, int plen);
Damien Millerb38eff82000-04-01 11:09:21 +1000102void channel_input_open(int type, int plen);
103
104/* Sets specific protocol options. */
105void channel_set_options(int hostname_in_open);
106
107/*
108 * Allocate a new channel object and set its type and socket. Remote_name
109 * must have been allocated with xmalloc; this will free it when the channel
110 * is freed.
111 */
112int channel_allocate(int type, int sock, char *remote_name);
113
114/* Free the channel and close its socket. */
115void channel_free(int channel);
116
117/* Add any bits relevant to channels in select bitmasks. */
118void channel_prepare_select(fd_set * readset, fd_set * writeset);
119
120/*
121 * After select, perform any appropriate operations for channels which have
122 * events pending.
123 */
124void channel_after_select(fd_set * readset, fd_set * writeset);
125
126/* If there is data to send to the connection, send some of it now. */
127void channel_output_poll(void);
128
129/* Returns true if no channel has too much buffered data. */
130int channel_not_very_much_buffered_data(void);
131
132/* This closes any sockets that are listening for connections; this removes
133 any unix domain sockets. */
134void channel_stop_listening(void);
135
136/*
137 * Closes the sockets of all channels. This is used to close extra file
138 * descriptors after a fork.
139 */
140void channel_close_all(void);
141
142/* Returns the maximum file descriptor number used by the channels. */
143int channel_max_fd(void);
144
145/* Returns true if there is still an open channel over the connection. */
146int channel_still_open(void);
147
148/*
149 * Returns a string containing a list of all open channels. The list is
150 * suitable for displaying to the user. It uses crlf instead of newlines.
151 * The caller should free the string with xfree.
152 */
153char *channel_open_message(void);
154
155/*
156 * Initiate forwarding of connections to local port "port" through the secure
157 * channel to host:port from remote side. This never returns if there was an
158 * error.
159 */
Damien Miller4af51302000-04-16 11:18:38 +1000160void
Damien Millerb38eff82000-04-01 11:09:21 +1000161channel_request_local_forwarding(u_short port, const char *host,
162 u_short remote_port, int gateway_ports);
163
164/*
165 * Initiate forwarding of connections to port "port" on remote host through
166 * the secure channel to host:port from local side. This never returns if
167 * there was an error. This registers that open requests for that port are
168 * permitted.
169 */
Damien Miller4af51302000-04-16 11:18:38 +1000170void
Damien Millerb38eff82000-04-01 11:09:21 +1000171channel_request_remote_forwarding(u_short port, const char *host,
172 u_short remote_port);
173
174/*
175 * Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
176 * called by the server, because the user could connect to any port anyway,
177 * and the server has no way to know but to trust the client anyway.
178 */
179void channel_permit_all_opens(void);
180
181/*
182 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
183 * listening for the port, and sends back a success reply (or disconnect
184 * message if there was an error). This never returns if there was an error.
185 */
Damien Millere247cc42000-05-07 12:03:14 +1000186void channel_input_port_forward_request(int is_root, int gateway_ports);
Damien Millerb38eff82000-04-01 11:09:21 +1000187
188/*
189 * Creates a port for X11 connections, and starts listening for it. Returns
190 * the display name, or NULL if an error was encountered.
191 */
192char *x11_create_display(int screen);
193
194/*
195 * Creates an internet domain socket for listening for X11 connections.
196 * Returns a suitable value for the DISPLAY variable, or NULL if an error
197 * occurs.
198 */
199char *x11_create_display_inet(int screen, int x11_display_offset);
200
201/*
202 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
203 * the remote channel number. We should do whatever we want, and respond
204 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
205 */
206void x11_input_open(int type, int plen);
207
208/*
209 * Requests forwarding of X11 connections. This should be called on the
210 * client only.
211 */
212void x11_request_forwarding(void);
213
214/*
215 * Requests forwarding for X11 connections, with authentication spoofing.
216 * This should be called in the client only.
217 */
Damien Millerbd483e72000-04-30 10:00:53 +1000218void
219x11_request_forwarding_with_spoofing(int client_session_id,
220 const char *proto, const char *data);
Damien Millerb38eff82000-04-01 11:09:21 +1000221
222/* Sends a message to the server to request authentication fd forwarding. */
223void auth_request_forwarding(void);
224
225/*
226 * Returns the name of the forwarded authentication socket. Returns NULL if
227 * there is no forwarded authentication socket. The returned value points to
228 * a static buffer.
229 */
230char *auth_get_socket_name(void);
231
232/*
Damien Millerd3a18572000-06-07 19:55:44 +1000233 * This is called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
Damien Millerb38eff82000-04-01 11:09:21 +1000234 * This starts forwarding authentication requests.
235 */
Damien Millerd3a18572000-06-07 19:55:44 +1000236int auth_input_request_forwarding(struct passwd * pw);
Damien Millerb38eff82000-04-01 11:09:21 +1000237
238/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
239void auth_input_open_request(int type, int plen);
240
Damien Miller33b13562000-04-04 14:38:59 +1000241/* XXX */
242int channel_connect_to(const char *host, u_short host_port);
Damien Millerbd483e72000-04-30 10:00:53 +1000243int x11_connect_display(void);
Damien Miller33b13562000-04-04 14:38:59 +1000244
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000245#endif