[gssapi-openssh.git] / openssh / channels.h

/*	$OpenBSD: channels.h,v 1.83 2005/12/30 15:56:37 reyk Exp $	*/

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */
/*
 * Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CHANNEL_H
#define CHANNEL_H

#include "buffer.h"

/* Definitions for channel types. */
#define SSH_CHANNEL_X11_LISTENER	1	/* Listening for inet X11 conn. */
#define SSH_CHANNEL_PORT_LISTENER	2	/* Listening on a port. */
#define SSH_CHANNEL_OPENING		3	/* waiting for confirmation */
#define SSH_CHANNEL_OPEN		4	/* normal open two-way channel */
#define SSH_CHANNEL_CLOSED		5	/* waiting for close confirmation */
#define SSH_CHANNEL_AUTH_SOCKET		6	/* authentication socket */
#define SSH_CHANNEL_X11_OPEN		7	/* reading first X11 packet */
#define SSH_CHANNEL_INPUT_DRAINING	8	/* sending remaining data to conn */
#define SSH_CHANNEL_OUTPUT_DRAINING	9	/* sending remaining data to app */
#define SSH_CHANNEL_LARVAL		10	/* larval session */
#define SSH_CHANNEL_RPORT_LISTENER	11	/* Listening to a R-style port  */
#define SSH_CHANNEL_CONNECTING		12
#define SSH_CHANNEL_DYNAMIC		13
#define SSH_CHANNEL_ZOMBIE		14	/* Almost dead. */
#define SSH_CHANNEL_MAX_TYPE		15

#define SSH_CHANNEL_PATH_LEN		256

struct Channel;
typedef struct Channel Channel;

typedef void channel_callback_fn(int, void *);
typedef int channel_infilter_fn(struct Channel *, char *, int);
typedef u_char *channel_outfilter_fn(struct Channel *, u_char **, u_int *);

struct Channel {
	int     type;		/* channel type/state */
	int     self;		/* my own channel identifier */
	int     remote_id;	/* channel identifier for remote peer */
	u_int   istate;		/* input from channel (state of receive half) */
	u_int   ostate;		/* output to channel  (state of transmit half) */
	int     flags;		/* close sent/rcvd */
	int     rfd;		/* read fd */
	int     wfd;		/* write fd */
	int     efd;		/* extended fd */
	int     sock;		/* sock fd */
	int     ctl_fd;		/* control fd (client sharing) */
	int     isatty;		/* rfd is a tty */
	int     wfd_isatty;	/* wfd is a tty */
	int	client_tty;	/* (client) TTY has been requested */
	int     force_drain;	/* force close on iEOF */
	int     delayed;		/* fdset hack */
	Buffer  input;		/* data read from socket, to be sent over
				 * encrypted connection */
	Buffer  output;		/* data received over encrypted connection for
				 * send on socket */
	Buffer  extended;
	char    path[SSH_CHANNEL_PATH_LEN];
		/* path for unix domain sockets, or host name for forwards */
	int     listening_port;	/* port being listened for forwards */
	int     host_port;	/* remote port to connect for forwards */
	char   *remote_name;	/* remote hostname */

	u_int	remote_window;
	u_int	remote_maxpacket;
	u_int	local_window;
	u_int	local_window_max;
	u_int	local_consumed;
	u_int	local_maxpacket;
	int	dynamic_window;
	int     extended_usage;
	int	single_connection;

	char   *ctype;		/* type */

	/* callback */
	channel_callback_fn	*confirm;
	void			*confirm_ctx;
	channel_callback_fn	*detach_user;
	int			detach_close;

	/* filter */
	channel_infilter_fn	*input_filter;
	channel_outfilter_fn	*output_filter;

	int     datagram;	/* keep boundaries */
};

#define CHAN_EXTENDED_IGNORE		0
#define CHAN_EXTENDED_READ		1
#define CHAN_EXTENDED_WRITE		2

/* default window/packet sizes for tcp/x11-fwd-channel */
#define CHAN_SES_PACKET_DEFAULT	(32*1024)
#define CHAN_SES_WINDOW_DEFAULT	(0xa00000/2)
#define CHAN_TCP_PACKET_DEFAULT	(32*1024)
#define CHAN_TCP_WINDOW_DEFAULT	(0xa00000/2)
#define CHAN_X11_PACKET_DEFAULT	(16*1024)
#define CHAN_X11_WINDOW_DEFAULT	(0xa00000/2)

/* possible input states */
#define CHAN_INPUT_OPEN			0
#define CHAN_INPUT_WAIT_DRAIN		1
#define CHAN_INPUT_WAIT_OCLOSE		2
#define CHAN_INPUT_CLOSED		3

/* possible output states */
#define CHAN_OUTPUT_OPEN		0
#define CHAN_OUTPUT_WAIT_DRAIN		1
#define CHAN_OUTPUT_WAIT_IEOF		2
#define CHAN_OUTPUT_CLOSED		3

#define CHAN_CLOSE_SENT			0x01
#define CHAN_CLOSE_RCVD			0x02
#define CHAN_EOF_SENT			0x04
#define CHAN_EOF_RCVD			0x08

#define CHAN_RBUF	16*1024

/* check whether 'efd' is still in use */
#define CHANNEL_EFD_INPUT_ACTIVE(c) \
	(compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
	(c->efd != -1 || \
	buffer_len(&c->extended) > 0))
#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
	(compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
	c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD)) || \
	buffer_len(&c->extended) > 0))

/* channel management */

Channel	*channel_by_id(int);
Channel	*channel_lookup(int);
Channel *channel_new(char *, int, int, int, int, u_int, u_int, int, char *, int);
void	 channel_set_fds(int, int, int, int, int, int, u_int);
void	 channel_free(Channel *);
void	 channel_free_all(void);
void	 channel_stop_listening(void);

void	 channel_send_open(int);
void	 channel_request_start(int, char *, int);
void	 channel_register_cleanup(int, channel_callback_fn *, int);
void	 channel_register_confirm(int, channel_callback_fn *, void *);
void	 channel_register_filter(int, channel_infilter_fn *, channel_outfilter_fn *);
void	 channel_cancel_cleanup(int);
int	 channel_close_fd(int *);
void	 channel_send_window_changes(void);

/* protocol handler */

void	 channel_input_close(int, u_int32_t, void *);
void	 channel_input_close_confirmation(int, u_int32_t, void *);
void	 channel_input_data(int, u_int32_t, void *);
void	 channel_input_extended_data(int, u_int32_t, void *);
void	 channel_input_ieof(int, u_int32_t, void *);
void	 channel_input_oclose(int, u_int32_t, void *);
void	 channel_input_open_confirmation(int, u_int32_t, void *);
void	 channel_input_open_failure(int, u_int32_t, void *);
void	 channel_input_port_open(int, u_int32_t, void *);
void	 channel_input_window_adjust(int, u_int32_t, void *);

/* file descriptor handling (read/write) */

void	 channel_prepare_select(fd_set **, fd_set **, int *, u_int*, int);
void     channel_after_select(fd_set *, fd_set *);
void     channel_output_poll(void);

int      channel_not_very_much_buffered_data(void);
void     channel_close_all(void);
int      channel_still_open(void);
char	*channel_open_message(void);
int	 channel_find_open(void);

/* tcp forwarding */
void	 channel_set_af(int af);
void     channel_permit_all_opens(void);
void	 channel_add_permitted_opens(char *, int);
void	 channel_clear_permitted_opens(void);
void     channel_input_port_forward_request(int, int);
int	 channel_connect_to(const char *, u_short);
int	 channel_connect_by_listen_address(u_short);
void	 channel_request_remote_forwarding(const char *, u_short,
	     const char *, u_short);
int	 channel_setup_local_fwd_listener(const char *, u_short,
	     const char *, u_short, int);
void	 channel_request_rforward_cancel(const char *host, u_short port);
int	 channel_setup_remote_fwd_listener(const char *, u_short, int);
int	 channel_cancel_rport_listener(const char *, u_short);

/* x11 forwarding */

int	 x11_connect_display(void);
int	 x11_create_display_inet(int, int, int, u_int *, int **);
void     x11_input_open(int, u_int32_t, void *);
void	 x11_request_forwarding_with_spoofing(int, const char *, const char *,
	    const char *);
void	 deny_input_open(int, u_int32_t, void *);

/* agent forwarding */

void	 auth_request_forwarding(void);

/* channel close */

int	 chan_is_dead(Channel *, int);
void	 chan_mark_dead(Channel *);

/* channel events */

void	 chan_rcvd_oclose(Channel *);
void	 chan_read_failed(Channel *);
void	 chan_ibuf_empty(Channel *);

void	 chan_rcvd_ieof(Channel *);
void	 chan_write_failed(Channel *);
void	 chan_obuf_empty(Channel *);

#endif
Commit	Line	Data
08822d99	1	/* $OpenBSD: channels.h,v 1.83 2005/12/30 15:56:37 reyk Exp $ */
473db5ab	2
3c0ef626	3	/*
	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	/*
473db5ab	15	* Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved.
3c0ef626	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	*/
3c0ef626	37
	38	#ifndef CHANNEL_H
	39	#define CHANNEL_H
	40
	41	#include "buffer.h"
	42
	43	/* Definitions for channel types. */
	44	#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
	45	#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */
	46	#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */
	47	#define SSH_CHANNEL_OPEN 4 /* normal open two-way channel */
	48	#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
	49	#define SSH_CHANNEL_AUTH_SOCKET 6 /* authentication socket */
	50	#define SSH_CHANNEL_X11_OPEN 7 /* reading first X11 packet */
	51	#define SSH_CHANNEL_INPUT_DRAINING 8 /* sending remaining data to conn */
	52	#define SSH_CHANNEL_OUTPUT_DRAINING 9 /* sending remaining data to app */
	53	#define SSH_CHANNEL_LARVAL 10 /* larval session */
	54	#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
	55	#define SSH_CHANNEL_CONNECTING 12
	56	#define SSH_CHANNEL_DYNAMIC 13
	57	#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
	58	#define SSH_CHANNEL_MAX_TYPE 15
	59
	60	#define SSH_CHANNEL_PATH_LEN 256
	61
	62	struct Channel;
	63	typedef struct Channel Channel;
	64
	65	typedef void channel_callback_fn(int, void *);
08822d99	66	typedef int channel_infilter_fn(struct Channel , char , int);
08822d99	67	typedef u_char channel_outfilter_fn(struct Channel , u_char *, u_int );
3c0ef626	68
	69	struct Channel {
	70	int type; /* channel type/state */
	71	int self; /* my own channel identifier */
	72	int remote_id; /* channel identifier for remote peer */
473db5ab	73	u_int istate; /* input from channel (state of receive half) */
473db5ab	74	u_int ostate; /* output to channel (state of transmit half) */
3c0ef626	75	int flags; /* close sent/rcvd */
	76	int rfd; /* read fd */
	77	int wfd; /* write fd */
	78	int efd; /* extended fd */
	79	int sock; /* sock fd */
473db5ab	80	int ctl_fd; /* control fd (client sharing) */
3c0ef626	81	int isatty; /* rfd is a tty */
473db5ab	82	int wfd_isatty; /* wfd is a tty */
473db5ab	83	int client_tty; /* (client) TTY has been requested */
3c0ef626	84	int force_drain; /* force close on iEOF */
	85	int delayed; /* fdset hack */
	86	Buffer input; /* data read from socket, to be sent over
	87	* encrypted connection */
	88	Buffer output; /* data received over encrypted connection for
	89	* send on socket */
	90	Buffer extended;
	91	char path[SSH_CHANNEL_PATH_LEN];
	92	/* path for unix domain sockets, or host name for forwards */
	93	int listening_port; /* port being listened for forwards */
	94	int host_port; /* remote port to connect for forwards */
	95	char remote_name; / remote hostname */
	96
473db5ab	97	u_int remote_window;
	98	u_int remote_maxpacket;
	99	u_int local_window;
	100	u_int local_window_max;
	101	u_int local_consumed;
	102	u_int local_maxpacket;
	103	int dynamic_window;
3c0ef626	104	int extended_usage;
473db5ab	105	int single_connection;
3c0ef626	106
	107	char ctype; / type */
	108
	109	/* callback */
473db5ab	110	channel_callback_fn *confirm;
473db5ab	111	void *confirm_ctx;
08822d99	112	channel_callback_fn *detach_user;
08822d99	113	int detach_close;
3c0ef626	114
3c0ef626	115	/* filter */
08822d99	116	channel_infilter_fn *input_filter;
	117	channel_outfilter_fn *output_filter;
	118
	119	int datagram; /* keep boundaries */
3c0ef626	120	};
	121
	122	#define CHAN_EXTENDED_IGNORE 0
	123	#define CHAN_EXTENDED_READ 1
	124	#define CHAN_EXTENDED_WRITE 2
	125
	126	/* default window/packet sizes for tcp/x11-fwd-channel */
473db5ab	127	#define CHAN_SES_PACKET_DEFAULT (32*1024)
	128	#define CHAN_SES_WINDOW_DEFAULT (0xa00000/2)
	129	#define CHAN_TCP_PACKET_DEFAULT (32*1024)
	130	#define CHAN_TCP_WINDOW_DEFAULT (0xa00000/2)
	131	#define CHAN_X11_PACKET_DEFAULT (16*1024)
	132	#define CHAN_X11_WINDOW_DEFAULT (0xa00000/2)
3c0ef626	133
3c0ef626	134	/* possible input states */
473db5ab	135	#define CHAN_INPUT_OPEN 0
	136	#define CHAN_INPUT_WAIT_DRAIN 1
	137	#define CHAN_INPUT_WAIT_OCLOSE 2
	138	#define CHAN_INPUT_CLOSED 3
3c0ef626	139
3c0ef626	140	/* possible output states */
473db5ab	141	#define CHAN_OUTPUT_OPEN 0
	142	#define CHAN_OUTPUT_WAIT_DRAIN 1
	143	#define CHAN_OUTPUT_WAIT_IEOF 2
	144	#define CHAN_OUTPUT_CLOSED 3
3c0ef626	145
	146	#define CHAN_CLOSE_SENT 0x01
	147	#define CHAN_CLOSE_RCVD 0x02
473db5ab	148	#define CHAN_EOF_SENT 0x04
	149	#define CHAN_EOF_RCVD 0x08
	150
08822d99	151	#define CHAN_RBUF 16*1024
08822d99	152
473db5ab	153	/* check whether 'efd' is still in use */
	154	#define CHANNEL_EFD_INPUT_ACTIVE(c) \
	155	(compat20 && c->extended_usage == CHAN_EXTENDED_READ && \
	156	(c->efd != -1 \|\| \
	157	buffer_len(&c->extended) > 0))
	158	#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \
	159	(compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \
	160	c->efd != -1 && (!(c->flags & (CHAN_EOF_RCVD\|CHAN_CLOSE_RCVD)) \|\| \
	161	buffer_len(&c->extended) > 0))
3c0ef626	162
	163	/* channel management */
	164
08822d99	165	Channel *channel_by_id(int);
3c0ef626	166	Channel *channel_lookup(int);
473db5ab	167	Channel channel_new(char , int, int, int, int, u_int, u_int, int, char *, int);
473db5ab	168	void channel_set_fds(int, int, int, int, int, int, u_int);
3c0ef626	169	void channel_free(Channel *);
	170	void channel_free_all(void);
	171	void channel_stop_listening(void);
	172
	173	void channel_send_open(int);
3c0ef626	174	void channel_request_start(int, char *, int);
08822d99	175	void channel_register_cleanup(int, channel_callback_fn *, int);
473db5ab	176	void channel_register_confirm(int, channel_callback_fn , void );
08822d99	177	void channel_register_filter(int, channel_infilter_fn , channel_outfilter_fn );
3c0ef626	178	void channel_cancel_cleanup(int);
3c0ef626	179	int channel_close_fd(int *);
473db5ab	180	void channel_send_window_changes(void);
3c0ef626	181
	182	/* protocol handler */
	183
473db5ab	184	void channel_input_close(int, u_int32_t, void *);
	185	void channel_input_close_confirmation(int, u_int32_t, void *);
	186	void channel_input_data(int, u_int32_t, void *);
	187	void channel_input_extended_data(int, u_int32_t, void *);
	188	void channel_input_ieof(int, u_int32_t, void *);
	189	void channel_input_oclose(int, u_int32_t, void *);
	190	void channel_input_open_confirmation(int, u_int32_t, void *);
	191	void channel_input_open_failure(int, u_int32_t, void *);
	192	void channel_input_port_open(int, u_int32_t, void *);
	193	void channel_input_window_adjust(int, u_int32_t, void *);
3c0ef626	194
	195	/* file descriptor handling (read/write) */
	196
473db5ab	197	void channel_prepare_select(fd_set , fd_set , int , u_int, int);
3c0ef626	198	void channel_after_select(fd_set , fd_set );
	199	void channel_output_poll(void);
	200
	201	int channel_not_very_much_buffered_data(void);
	202	void channel_close_all(void);
	203	int channel_still_open(void);
	204	char *channel_open_message(void);
	205	int channel_find_open(void);
	206
	207	/* tcp forwarding */
	208	void channel_set_af(int af);
	209	void channel_permit_all_opens(void);
	210	void channel_add_permitted_opens(char *, int);
	211	void channel_clear_permitted_opens(void);
	212	void channel_input_port_forward_request(int, int);
	213	int channel_connect_to(const char *, u_short);
	214	int channel_connect_by_listen_address(u_short);
473db5ab	215	void channel_request_remote_forwarding(const char *, u_short,
	216	const char *, u_short);
	217	int channel_setup_local_fwd_listener(const char *, u_short,
	218	const char *, u_short, int);
	219	void channel_request_rforward_cancel(const char *host, u_short port);
	220	int channel_setup_remote_fwd_listener(const char *, u_short, int);
	221	int channel_cancel_rport_listener(const char *, u_short);
3c0ef626	222
	223	/* x11 forwarding */
	224
	225	int x11_connect_display(void);
473db5ab	226	int x11_create_display_inet(int, int, int, u_int , int *);
	227	void x11_input_open(int, u_int32_t, void *);
	228	void x11_request_forwarding_with_spoofing(int, const char , const char ,
	229	const char *);
	230	void deny_input_open(int, u_int32_t, void *);
3c0ef626	231
	232	/* agent forwarding */
	233
	234	void auth_request_forwarding(void);
3c0ef626	235
	236	/* channel close */
	237
	238	int chan_is_dead(Channel *, int);
	239	void chan_mark_dead(Channel *);
3c0ef626	240
473db5ab	241	/* channel events */
3c0ef626	242
473db5ab	243	void chan_rcvd_oclose(Channel *);
	244	void chan_read_failed(Channel *);
	245	void chan_ibuf_empty(Channel *);
3c0ef626	246
473db5ab	247	void chan_rcvd_ieof(Channel *);
	248	void chan_write_failed(Channel *);
	249	void chan_obuf_empty(Channel *);
3c0ef626	250
3c0ef626	251	#endif