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