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