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