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