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