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