Annotation of src/usr.bin/ssh/channels.h, Revision 1.41
1.17 deraadt 1: /*
1.19 markus 2: * Author: Tatu Ylonen <ylo@cs.hut.fi>
3: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4: * All rights reserved
5: *
6: * As far as I am concerned, the code I have written for this software
7: * can be used freely for any purpose. Any derived versions of this
8: * software must be clearly marked as such, and if the derived work is
9: * incompatible with the protocol description in the RFC file, it must be
10: * called by a name other than "ssh" or "Secure Shell".
11: */
12: /*
1.40 markus 13: * Copyright (c) 1999, 2000, 2001 Markus Friedl. All rights reserved.
1.17 deraadt 14: *
15: * Redistribution and use in source and binary forms, with or without
16: * modification, are permitted provided that the following conditions
17: * are met:
18: * 1. Redistributions of source code must retain the above copyright
19: * notice, this list of conditions and the following disclaimer.
20: * 2. Redistributions in binary form must reproduce the above copyright
21: * notice, this list of conditions and the following disclaimer in the
22: * documentation and/or other materials provided with the distribution.
23: *
24: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34: */
1.41 ! itojun 35: /* RCSID("$OpenBSD: channels.h,v 1.40 2001/06/25 08:25:36 markus Exp $"); */
1.2 markus 36:
1.35 markus 37: #ifndef CHANNEL_H
38: #define CHANNEL_H
1.1 markus 39:
1.28 markus 40: #include "buffer.h"
41:
1.1 markus 42: /* Definitions for channel types. */
1.6 markus 43: #define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
1.5 deraadt 44: #define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
45: #define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
46: #define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
1.6 markus 47: #define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
1.7 markus 48: #define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
49: #define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
50: #define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
51: #define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
52: #define SSH_CHANNEL_LARVAL 10 /* larval session */
1.23 markus 53: #define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
1.24 markus 54: #define SSH_CHANNEL_CONNECTING 12
1.30 markus 55: #define SSH_CHANNEL_DYNAMIC 13
1.33 markus 56: #define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
57: #define SSH_CHANNEL_MAX_TYPE 15
1.1 markus 58:
1.32 markus 59: #define SSH_CHANNEL_PATH_LEN 30
60:
1.6 markus 61: /*
1.32 markus 62: * Data structure for channel data. This is initialized in channel_new
1.6 markus 63: * and cleared in channel_free.
64: */
1.16 markus 65: struct Channel;
66: typedef struct Channel Channel;
67:
1.41 ! itojun 68: typedef void channel_callback_fn(int, void *);
! 69: typedef int channel_filter_fn(struct Channel *, char *, int);
1.1 markus 70:
1.16 markus 71: struct Channel {
1.5 deraadt 72: int type; /* channel type/state */
73: int self; /* my own channel identifier */
74: int remote_id; /* channel identifier for remote peer */
75: /* peer can be reached over encrypted connection, via packet-sent */
76: int istate; /* input from channel (state of receive half) */
77: int ostate; /* output to channel (state of transmit half) */
1.8 markus 78: int flags; /* close sent/rcvd */
1.7 markus 79: int rfd; /* read fd */
80: int wfd; /* write fd */
81: int efd; /* extended fd */
82: int sock; /* sock fd */
1.27 markus 83: int isatty; /* rfd is a tty */
1.5 deraadt 84: Buffer input; /* data read from socket, to be sent over
85: * encrypted connection */
86: Buffer output; /* data received over encrypted connection for
87: * send on socket */
1.7 markus 88: Buffer extended;
1.32 markus 89: char path[SSH_CHANNEL_PATH_LEN];
90: /* path for unix domain sockets, or host name for forwards */
1.5 deraadt 91: int listening_port; /* port being listened for forwards */
92: int host_port; /* remote port to connect for forwards */
93: char *remote_name; /* remote hostname */
1.7 markus 94:
95: int remote_window;
96: int remote_maxpacket;
97: int local_window;
98: int local_window_max;
99: int local_consumed;
100: int local_maxpacket;
101: int extended_usage;
102:
103: char *ctype; /* type */
104:
1.11 markus 105: /* callback */
1.7 markus 106: channel_callback_fn *cb_fn;
107: void *cb_arg;
108: int cb_event;
109: channel_callback_fn *dettach_user;
1.15 markus 110:
111: /* filter */
112: channel_filter_fn *input_filter;
1.16 markus 113: };
1.7 markus 114:
115: #define CHAN_EXTENDED_IGNORE 0
116: #define CHAN_EXTENDED_READ 1
117: #define CHAN_EXTENDED_WRITE 2
1.18 markus 118:
119: /* default window/packet sizes for tcp/x11-fwd-channel */
120: #define CHAN_SES_WINDOW_DEFAULT (32*1024)
121: #define CHAN_SES_PACKET_DEFAULT (CHAN_SES_WINDOW_DEFAULT/2)
122: #define CHAN_TCP_WINDOW_DEFAULT (32*1024)
123: #define CHAN_TCP_PACKET_DEFAULT (CHAN_TCP_WINDOW_DEFAULT/2)
124: #define CHAN_X11_WINDOW_DEFAULT (4*1024)
125: #define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2)
126:
1.35 markus 127: /* possible input states */
128: #define CHAN_INPUT_OPEN 0x01
129: #define CHAN_INPUT_WAIT_DRAIN 0x02
130: #define CHAN_INPUT_WAIT_OCLOSE 0x04
131: #define CHAN_INPUT_CLOSED 0x08
132:
133: /* possible output states */
134: #define CHAN_OUTPUT_OPEN 0x10
135: #define CHAN_OUTPUT_WAIT_DRAIN 0x20
136: #define CHAN_OUTPUT_WAIT_IEOF 0x40
137: #define CHAN_OUTPUT_CLOSED 0x80
1.7 markus 138:
1.35 markus 139: #define CHAN_CLOSE_SENT 0x01
140: #define CHAN_CLOSE_RCVD 0x02
141:
142:
143: /* channel management */
144:
1.41 ! itojun 145: Channel *channel_lookup(int);
! 146: Channel *channel_new(char *, int, int, int, int, int, int, int, char *, int);
! 147: void channel_set_fds(int, int, int, int, int, int);
! 148: void channel_free(Channel *);
1.39 markus 149: void channel_free_all(void);
1.35 markus 150:
1.41 ! itojun 151: void channel_send_open(int);
! 152: void channel_request(int, char *, int);
! 153: void channel_request_start(int, char *, int);
! 154: void channel_register_callback(int, int mtype, channel_callback_fn *, void *);
! 155: void channel_register_cleanup(int, channel_callback_fn *);
! 156: void channel_register_filter(int, channel_filter_fn *);
! 157: void channel_cancel_cleanup(int);
1.22 markus 158:
1.35 markus 159: /* protocol handler */
1.7 markus 160:
1.41 ! itojun 161: void channel_input_channel_request(int, int, void *);
! 162: void channel_input_close(int, int, void *);
! 163: void channel_input_close_confirmation(int, int, void *);
! 164: void channel_input_data(int, int, void *);
! 165: void channel_input_extended_data(int, int, void *);
! 166: void channel_input_ieof(int, int, void *);
! 167: void channel_input_oclose(int, int, void *);
! 168: void channel_input_open_confirmation(int, int, void *);
! 169: void channel_input_open_failure(int, int, void *);
! 170: void channel_input_port_open(int, int, void *);
! 171: void channel_input_window_adjust(int, int, void *);
1.7 markus 172:
1.35 markus 173: /* file descriptor handling (read/write) */
1.7 markus 174:
1.25 markus 175: void
1.41 ! itojun 176: channel_prepare_select(fd_set **, fd_set **, int *, int);
! 177: void channel_after_select(fd_set *, fd_set *);
1.7 markus 178: void channel_output_poll(void);
179:
180: int channel_not_very_much_buffered_data(void);
181: void channel_close_all(void);
1.39 markus 182: void channel_free_all(void);
1.7 markus 183: int channel_still_open(void);
184: char *channel_open_message(void);
1.35 markus 185: int channel_find_open(void);
1.7 markus 186:
1.35 markus 187: /* channel_tcpfwd.c */
1.26 markus 188: int
1.41 ! itojun 189: channel_request_local_forwarding(u_short, const char *, u_short, int);
1.26 markus 190: int
1.41 ! itojun 191: channel_request_forwarding(const char *, u_short, const char *, u_short, int,
! 192: int);
1.9 markus 193: void
1.41 ! itojun 194: channel_request_remote_forwarding(u_short, const char *, u_short);
1.7 markus 195: void channel_permit_all_opens(void);
1.41 ! itojun 196: void channel_add_permitted_opens(char *, int);
1.28 markus 197: void channel_clear_permitted_opens(void);
1.41 ! itojun 198: void channel_input_port_forward_request(int, int);
! 199: int channel_connect_to(const char *, u_short);
! 200: int channel_connect_by_listen_adress(u_short);
1.7 markus 201:
1.35 markus 202: /* x11 forwarding */
1.7 markus 203:
1.35 markus 204: int x11_connect_display(void);
1.41 ! itojun 205: char *x11_create_display(int);
! 206: char *x11_create_display_inet(int, int);
! 207: void x11_input_open(int, int, void *);
1.7 markus 208: void x11_request_forwarding(void);
1.10 markus 209: void
1.41 ! itojun 210: x11_request_forwarding_with_spoofing(int, const char *, const char *);
! 211: void deny_input_open(int, int, void *);
1.35 markus 212:
213: /* agent forwarding */
1.7 markus 214:
215: void auth_request_forwarding(void);
216: char *auth_get_socket_name(void);
1.41 ! itojun 217: void auth_sock_cleanup_proc(void *);
! 218: int auth_input_request_forwarding(struct passwd *);
! 219: void auth_input_open_request(int, int, void *);
1.7 markus 220:
1.35 markus 221: /* channel close */
1.8 markus 222:
1.41 ! itojun 223: typedef void chan_event_fn(Channel *);
1.31 beck 224:
1.35 markus 225: /* for the input state */
226: extern chan_event_fn *chan_rcvd_oclose;
227: extern chan_event_fn *chan_read_failed;
228: extern chan_event_fn *chan_ibuf_empty;
229:
230: /* for the output state */
231: extern chan_event_fn *chan_rcvd_ieof;
232: extern chan_event_fn *chan_write_failed;
233: extern chan_event_fn *chan_obuf_empty;
234:
1.41 ! itojun 235: int chan_is_dead(Channel *);
! 236: void chan_mark_dead(Channel *);
! 237: void chan_init_iostates(Channel *);
1.35 markus 238: void chan_init(void);
1.7 markus 239:
1.1 markus 240: #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