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