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