Annotation of src/usr.bin/ssh/channels.h, Revision 1.129
1.129 ! djm 1: /* $OpenBSD: channels.h,v 1.128 2017/09/12 06:32:07 djm Exp $ */
1.65 stevesk 2:
1.17 deraadt 3: /*
1.19 markus 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: /*
1.59 markus 15: * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
1.17 deraadt 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: */
1.2 markus 37:
1.35 markus 38: #ifndef CHANNEL_H
39: #define CHANNEL_H
1.28 markus 40:
1.1 markus 41: /* Definitions for channel types. */
1.6 markus 42: #define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
1.5 deraadt 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 */
1.6 markus 46: #define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
1.7 markus 47: #define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
48: #define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
49: #define SSH_CHANNEL_LARVAL 10 /* larval session */
1.23 markus 50: #define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
1.24 markus 51: #define SSH_CHANNEL_CONNECTING 12
1.30 markus 52: #define SSH_CHANNEL_DYNAMIC 13
1.33 markus 53: #define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
1.103 djm 54: #define SSH_CHANNEL_MUX_LISTENER 15 /* Listener for mux conn. */
55: #define SSH_CHANNEL_MUX_CLIENT 16 /* Conn. to mux slave */
1.113 dtucker 56: #define SSH_CHANNEL_ABANDONED 17 /* Abandoned session, eg mux */
1.115 millert 57: #define SSH_CHANNEL_UNIX_LISTENER 18 /* Listening on a domain socket. */
58: #define SSH_CHANNEL_RUNIX_LISTENER 19 /* Listening to a R-style domain socket. */
1.119 markus 59: #define SSH_CHANNEL_MUX_PROXY 20 /* proxy channel for mux-slave */
60: #define SSH_CHANNEL_MAX_TYPE 21
1.1 markus 61:
1.107 markus 62: #define CHANNEL_CANCEL_PORT_STATIC -1
63:
1.126 markus 64: struct ssh;
1.16 markus 65: struct Channel;
66: typedef struct Channel Channel;
1.128 djm 67: struct fwd_perm_list;
1.16 markus 68:
1.128 djm 69: typedef void channel_open_fn(struct ssh *, int, int, void *);
70: typedef void channel_callback_fn(struct ssh *, int, void *);
71: typedef int channel_infilter_fn(struct ssh *, struct Channel *, char *, int);
72: typedef void channel_filter_cleanup_fn(struct ssh *, int, void *);
73: typedef u_char *channel_outfilter_fn(struct ssh *, struct Channel *,
74: u_char **, size_t *);
1.1 markus 75:
1.90 djm 76: /* Channel success/failure callbacks */
1.128 djm 77: typedef void channel_confirm_cb(struct ssh *, int, struct Channel *, void *);
78: typedef void channel_confirm_abandon_cb(struct ssh *, struct Channel *, void *);
1.90 djm 79: struct channel_confirm {
80: TAILQ_ENTRY(channel_confirm) entry;
81: channel_confirm_cb *cb;
82: channel_confirm_abandon_cb *abandon_cb;
83: void *ctx;
84: };
85: TAILQ_HEAD(channel_confirms, channel_confirm);
86:
1.91 djm 87: /* Context for non-blocking connects */
88: struct channel_connect {
89: char *host;
90: int port;
91: struct addrinfo *ai, *aitop;
92: };
93:
1.103 djm 94: /* Callbacks for mux channels back into client-specific code */
1.128 djm 95: typedef int mux_callback_fn(struct ssh *, struct Channel *);
1.103 djm 96:
1.16 markus 97: struct Channel {
1.5 deraadt 98: int type; /* channel type/state */
99: int self; /* my own channel identifier */
1.129 ! djm 100: uint32_t remote_id; /* channel identifier for remote peer */
! 101: int have_remote_id; /* non-zero if remote_id is valid */
! 102:
1.57 markus 103: u_int istate; /* input from channel (state of receive half) */
104: u_int ostate; /* output to channel (state of transmit half) */
1.8 markus 105: int flags; /* close sent/rcvd */
1.7 markus 106: int rfd; /* read fd */
107: int wfd; /* write fd */
108: int efd; /* extended fd */
109: int sock; /* sock fd */
1.103 djm 110: int ctl_chan; /* control channel (multiplexed connections) */
1.27 markus 111: int isatty; /* rfd is a tty */
1.75 djm 112: int client_tty; /* (client) TTY has been requested */
1.48 markus 113: int force_drain; /* force close on iEOF */
1.111 djm 114: time_t notbefore; /* Pause IO until deadline (time_t) */
1.100 markus 115: int delayed; /* post-select handlers for newly created
116: * channels are delayed until the first call
1.117 djm 117: * to a matching pre-select handler.
1.100 markus 118: * this way post-select handlers are not
1.112 dtucker 119: * accidentally called if a FD gets reused */
1.128 djm 120: struct sshbuf *input; /* data read from socket, to be sent over
1.5 deraadt 121: * encrypted connection */
1.128 djm 122: struct sshbuf *output; /* data received over encrypted connection for
1.5 deraadt 123: * send on socket */
1.128 djm 124: struct sshbuf *extended;
125:
1.97 djm 126: char *path;
1.32 markus 127: /* path for unix domain sockets, or host name for forwards */
1.5 deraadt 128: int listening_port; /* port being listened for forwards */
1.106 djm 129: char *listening_addr; /* addr being listened for forwards */
1.5 deraadt 130: int host_port; /* remote port to connect for forwards */
131: char *remote_name; /* remote hostname */
1.7 markus 132:
1.70 markus 133: u_int remote_window;
134: u_int remote_maxpacket;
135: u_int local_window;
136: u_int local_window_max;
137: u_int local_consumed;
138: u_int local_maxpacket;
1.7 markus 139: int extended_usage;
1.54 markus 140: int single_connection;
1.7 markus 141:
142: char *ctype; /* type */
143:
1.11 markus 144: /* callback */
1.104 djm 145: channel_open_fn *open_confirm;
1.90 djm 146: void *open_confirm_ctx;
1.44 markus 147: channel_callback_fn *detach_user;
1.80 djm 148: int detach_close;
1.90 djm 149: struct channel_confirms status_confirms;
1.15 markus 150:
151: /* filter */
1.83 reyk 152: channel_infilter_fn *input_filter;
153: channel_outfilter_fn *output_filter;
1.94 djm 154: void *filter_ctx;
1.95 djm 155: channel_filter_cleanup_fn *filter_cleanup;
1.81 reyk 156:
1.91 djm 157: /* keep boundaries */
158: int datagram;
159:
160: /* non-blocking connect */
1.128 djm 161: /* XXX make this a pointer so the structure can be opaque */
1.91 djm 162: struct channel_connect connect_ctx;
1.103 djm 163:
164: /* multiplexing protocol hook, called for each packet received */
165: mux_callback_fn *mux_rcb;
166: void *mux_ctx;
1.104 djm 167: int mux_pause;
1.119 markus 168: int mux_downstream_id;
1.16 markus 169: };
1.7 markus 170:
171: #define CHAN_EXTENDED_IGNORE 0
172: #define CHAN_EXTENDED_READ 1
173: #define CHAN_EXTENDED_WRITE 2
1.18 markus 174:
175: /* default window/packet sizes for tcp/x11-fwd-channel */
1.64 markus 176: #define CHAN_SES_PACKET_DEFAULT (32*1024)
1.89 markus 177: #define CHAN_SES_WINDOW_DEFAULT (64*CHAN_SES_PACKET_DEFAULT)
1.64 markus 178: #define CHAN_TCP_PACKET_DEFAULT (32*1024)
1.89 markus 179: #define CHAN_TCP_WINDOW_DEFAULT (64*CHAN_TCP_PACKET_DEFAULT)
1.64 markus 180: #define CHAN_X11_PACKET_DEFAULT (16*1024)
181: #define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT)
1.18 markus 182:
1.35 markus 183: /* possible input states */
1.57 markus 184: #define CHAN_INPUT_OPEN 0
185: #define CHAN_INPUT_WAIT_DRAIN 1
186: #define CHAN_INPUT_WAIT_OCLOSE 2
187: #define CHAN_INPUT_CLOSED 3
1.35 markus 188:
189: /* possible output states */
1.57 markus 190: #define CHAN_OUTPUT_OPEN 0
191: #define CHAN_OUTPUT_WAIT_DRAIN 1
192: #define CHAN_OUTPUT_WAIT_IEOF 2
193: #define CHAN_OUTPUT_CLOSED 3
1.7 markus 194:
1.35 markus 195: #define CHAN_CLOSE_SENT 0x01
196: #define CHAN_CLOSE_RCVD 0x02
1.66 markus 197: #define CHAN_EOF_SENT 0x04
198: #define CHAN_EOF_RCVD 0x08
1.103 djm 199: #define CHAN_LOCAL 0x10
1.66 markus 200:
1.128 djm 201: /* Read buffer size */
202: #define CHAN_RBUF (16*1024)
203:
204: /* Hard limit on number of channels */
205: #define CHANNELS_MAX_CHANNELS (16*1024)
1.83 reyk 206:
1.66 markus 207: /* check whether 'efd' is still in use */
208: #define CHANNEL_EFD_INPUT_ACTIVE(c) \
1.122 djm 209: (c->extended_usage == CHAN_EXTENDED_READ && \
1.66 markus 210: (c->efd != -1 || \
1.128 djm 211: sshbuf_len(c->extended) > 0))
1.66 markus 212: #define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
1.122 djm 213: (c->extended_usage == CHAN_EXTENDED_WRITE && \
1.78 markus 214: c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
1.128 djm 215: sshbuf_len(c->extended) > 0))
216:
217: /* Add channel management structures to SSH transport instance */
218: void channel_init_channels(struct ssh *ssh);
1.35 markus 219:
220: /* channel management */
221:
1.128 djm 222: Channel *channel_by_id(struct ssh *, int);
1.129 ! djm 223: Channel *channel_by_remote_id(struct ssh *, u_int);
1.128 djm 224: Channel *channel_lookup(struct ssh *, int);
225: Channel *channel_new(struct ssh *, char *, int, int, int, int,
226: u_int, u_int, int, char *, int);
227: void channel_set_fds(struct ssh *, int, int, int, int, int,
228: int, int, u_int);
229: void channel_free(struct ssh *, Channel *);
230: void channel_free_all(struct ssh *);
231: void channel_stop_listening(struct ssh *);
232:
233: void channel_send_open(struct ssh *, int);
234: void channel_request_start(struct ssh *, int, char *, int);
235: void channel_register_cleanup(struct ssh *, int,
236: channel_callback_fn *, int);
237: void channel_register_open_confirm(struct ssh *, int,
238: channel_open_fn *, void *);
239: void channel_register_filter(struct ssh *, int, channel_infilter_fn *,
240: channel_outfilter_fn *, channel_filter_cleanup_fn *, void *);
241: void channel_register_status_confirm(struct ssh *, int,
242: channel_confirm_cb *, channel_confirm_abandon_cb *, void *);
243: void channel_cancel_cleanup(struct ssh *, int);
244: int channel_close_fd(struct ssh *, int *);
245: void channel_send_window_changes(struct ssh *);
1.119 markus 246:
247: /* mux proxy support */
248:
1.128 djm 249: int channel_proxy_downstream(struct ssh *, Channel *mc);
1.126 markus 250: int channel_proxy_upstream(Channel *, int, u_int32_t, struct ssh *);
1.22 markus 251:
1.35 markus 252: /* protocol handler */
1.7 markus 253:
1.126 markus 254: int channel_input_data(int, u_int32_t, struct ssh *);
255: int channel_input_extended_data(int, u_int32_t, struct ssh *);
256: int channel_input_ieof(int, u_int32_t, struct ssh *);
257: int channel_input_oclose(int, u_int32_t, struct ssh *);
258: int channel_input_open_confirmation(int, u_int32_t, struct ssh *);
259: int channel_input_open_failure(int, u_int32_t, struct ssh *);
260: int channel_input_port_open(int, u_int32_t, struct ssh *);
261: int channel_input_window_adjust(int, u_int32_t, struct ssh *);
262: int channel_input_status_confirm(int, u_int32_t, struct ssh *);
1.7 markus 263:
1.35 markus 264: /* file descriptor handling (read/write) */
1.7 markus 265:
1.127 djm 266: void channel_prepare_select(struct ssh *, fd_set **, fd_set **, int *,
267: u_int*, time_t*);
268: void channel_after_select(struct ssh *, fd_set *, fd_set *);
1.128 djm 269: void channel_output_poll(struct ssh *);
1.42 markus 270:
1.128 djm 271: int channel_not_very_much_buffered_data(struct ssh *);
272: void channel_close_all(struct ssh *);
273: int channel_still_open(struct ssh *);
274: char *channel_open_message(struct ssh *);
275: int channel_find_open(struct ssh *);
1.7 markus 276:
1.47 markus 277: /* tcp forwarding */
1.115 millert 278: struct Forward;
279: struct ForwardOptions;
1.128 djm 280: void channel_set_af(struct ssh *, int af);
281: void channel_permit_all_opens(struct ssh *);
282: void channel_add_permitted_opens(struct ssh *, char *, int);
283: int channel_add_adm_permitted_opens(struct ssh *, char *, int);
284: void channel_copy_adm_permitted_opens(struct ssh *,
285: const struct fwd_perm_list *);
286: void channel_disable_adm_local_opens(struct ssh *);
287: void channel_update_permitted_opens(struct ssh *, int, int);
288: void channel_clear_permitted_opens(struct ssh *);
289: void channel_clear_adm_permitted_opens(struct ssh *);
290: void channel_print_adm_permitted_opens(struct ssh *);
291: Channel *channel_connect_to_port(struct ssh *, const char *, u_short,
292: char *, char *, int *, const char **);
293: Channel *channel_connect_to_path(struct ssh *, const char *, char *, char *);
294: Channel *channel_connect_stdio_fwd(struct ssh *, const char*,
295: u_short, int, int);
296: Channel *channel_connect_by_listen_address(struct ssh *, const char *,
297: u_short, char *, char *);
298: Channel *channel_connect_by_listen_path(struct ssh *, const char *,
299: char *, char *);
300: int channel_request_remote_forwarding(struct ssh *, struct Forward *);
301: int channel_setup_local_fwd_listener(struct ssh *, struct Forward *,
302: struct ForwardOptions *);
303: int channel_request_rforward_cancel(struct ssh *, struct Forward *);
304: int channel_setup_remote_fwd_listener(struct ssh *, struct Forward *,
305: int *, struct ForwardOptions *);
306: int channel_cancel_rport_listener(struct ssh *, struct Forward *);
307: int channel_cancel_lport_listener(struct ssh *, struct Forward *,
308: int, struct ForwardOptions *);
1.108 dtucker 309: int permitopen_port(const char *);
1.7 markus 310:
1.35 markus 311: /* x11 forwarding */
1.7 markus 312:
1.128 djm 313: void channel_set_x11_refuse_time(struct ssh *, u_int);
314: int x11_connect_display(struct ssh *);
315: int x11_create_display_inet(struct ssh *, int, int, int, u_int *, int **);
316: void x11_request_forwarding_with_spoofing(struct ssh *, int,
317: const char *, const char *, const char *, int);
1.7 markus 318:
1.35 markus 319: /* channel close */
1.8 markus 320:
1.128 djm 321: int chan_is_dead(struct ssh *, Channel *, int);
322: void chan_mark_dead(struct ssh *, Channel *);
1.42 markus 323:
1.58 markus 324: /* channel events */
1.31 beck 325:
1.128 djm 326: void chan_rcvd_oclose(struct ssh *, Channel *);
327: void chan_rcvd_eow(struct ssh *, Channel *);
328: void chan_read_failed(struct ssh *, Channel *);
329: void chan_ibuf_empty(struct ssh *, Channel *);
330: void chan_rcvd_ieof(struct ssh *, Channel *);
331: void chan_write_failed(struct ssh *, Channel *);
332: void chan_obuf_empty(struct ssh *, Channel *);
1.7 markus 333:
1.1 markus 334: #endif
![[BACK]](/icons/back.gif){kind=icon}
Return to channels.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh