[openssh.git] / channels.h

/*
 * 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 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.
 */
/* RCSID("$OpenBSD: channels.h,v 1.49 2001/10/09 21:59:41 markus Exp $"); */

#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		30

struct Channel;
typedef struct Channel Channel;

typedef void channel_callback_fn(int, void *);
typedef int channel_filter_fn(struct Channel *, char *, int);

struct Channel {
	int     type;		/* channel type/state */
	int     self;		/* my own channel identifier */
	int     remote_id;	/* channel identifier for remote peer */
	int     istate;		/* input from channel (state of receive half) */
	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     isatty;		/* rfd is a tty */
	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 */

	int	remote_window;
	int	remote_maxpacket;
	int	local_window;
	int	local_window_max;
	int	local_consumed;
	int	local_maxpacket;
	int     extended_usage;

	char   *ctype;		/* type */

	/* callback */
	channel_callback_fn	*cb_fn;
	void	*cb_arg;
	int	cb_event;
	channel_callback_fn	*detach_user;

	/* filter */
	channel_filter_fn	*input_filter;
};

#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_WINDOW_DEFAULT	(32*1024)
#define CHAN_SES_PACKET_DEFAULT	(CHAN_SES_WINDOW_DEFAULT/2)
#define CHAN_TCP_WINDOW_DEFAULT	(32*1024)
#define CHAN_TCP_PACKET_DEFAULT	(CHAN_TCP_WINDOW_DEFAULT/2)
#define CHAN_X11_WINDOW_DEFAULT	(4*1024)
#define CHAN_X11_PACKET_DEFAULT	(CHAN_X11_WINDOW_DEFAULT/2)

/* possible input states */
#define CHAN_INPUT_OPEN			0x01
#define CHAN_INPUT_WAIT_DRAIN		0x02
#define CHAN_INPUT_WAIT_OCLOSE		0x04
#define CHAN_INPUT_CLOSED		0x08

/* possible output states */
#define CHAN_OUTPUT_OPEN		0x10
#define CHAN_OUTPUT_WAIT_DRAIN		0x20
#define CHAN_OUTPUT_WAIT_IEOF		0x40
#define CHAN_OUTPUT_CLOSED		0x80

#define CHAN_CLOSE_SENT			0x01
#define CHAN_CLOSE_RCVD			0x02

/* channel management */

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

void	 channel_send_open(int);
void	 channel_request(int, char *, int);
void	 channel_request_start(int, char *, int);
void	 channel_register_callback(int, int mtype, channel_callback_fn *, void *);
void	 channel_register_cleanup(int, channel_callback_fn *);
void	 channel_register_filter(int, channel_filter_fn *);
void	 channel_cancel_cleanup(int);
int	 channel_close_fd(int *);

/* protocol handler */

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

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

void	 channel_prepare_select(fd_set **, fd_set **, int *, 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(u_short, const char *, u_short);
int	 channel_request_local_forwarding(u_short, const char *, u_short, int);
int
channel_request_forwarding(const char *, u_short, const char *, u_short, int,
    int);

/* x11 forwarding */

int	 x11_connect_display(void);
char	*x11_create_display(int);
char	*x11_create_display_inet(int, int);
void     x11_input_open(int, int, void *);
void     x11_request_forwarding(void);
void	 x11_request_forwarding_with_spoofing(int, const char *, const char *);
void	 deny_input_open(int, int, void *);

/* agent forwarding */

void	 auth_request_forwarding(void);
char	*auth_get_socket_name(void);
void	 auth_sock_cleanup_proc(void *);
int	 auth_input_request_forwarding(struct passwd *);
void	 auth_input_open_request(int, int, void *);

/* channel close */

int	 chan_is_dead(Channel *);
void	 chan_mark_dead(Channel *);
void 	 chan_init_iostates(Channel *);
void	 chan_init(void);

typedef void    chan_event_fn(Channel *);

/* for the input state */
extern chan_event_fn	*chan_rcvd_oclose;
extern chan_event_fn	*chan_read_failed;
extern chan_event_fn	*chan_ibuf_empty;

/* for the output state */
extern chan_event_fn	*chan_rcvd_ieof;
extern chan_event_fn	*chan_write_failed;
extern chan_event_fn	*chan_obuf_empty;

#endif
Commit	Line	Data
bcbf86ec	1	/*
	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	/*
a96070d4	13	* Copyright (c) 1999, 2000, 2001 Markus Friedl. All rights reserved.
bcbf86ec	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	*/
d5f24f94	35	/* RCSID("$OpenBSD: channels.h,v 1.49 2001/10/09 21:59:41 markus Exp $"); */
8efc0c15	36
8e7895b8	37	#ifndef CHANNEL_H
8e7895b8	38	#define CHANNEL_H
8efc0c15	39
01794848	40	#include "buffer.h"
01794848	41
8efc0c15	42	/* Definitions for channel types. */
aa3378df	43	#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */
5260325f	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 */
aa3378df	47	#define SSH_CHANNEL_CLOSED 5 /* waiting for close confirmation */
7368a6c8	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 */
fa08c86b	53	#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */
97fb6912	54	#define SSH_CHANNEL_CONNECTING 12
0490e609	55	#define SSH_CHANNEL_DYNAMIC 13
6fd8622b	56	#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */
6fd8622b	57	#define SSH_CHANNEL_MAX_TYPE 15
8efc0c15	58
719fc62f	59	#define SSH_CHANNEL_PATH_LEN 30
719fc62f	60
2e73a022	61	struct Channel;
	62	typedef struct Channel Channel;
	63
2a1e4639	64	typedef void channel_callback_fn(int, void *);
2a1e4639	65	typedef int channel_filter_fn(struct Channel , char , int);
8efc0c15	66
2e73a022	67	struct Channel {
5260325f	68	int type; /* channel type/state */
	69	int self; /* my own channel identifier */
	70	int remote_id; /* channel identifier for remote peer */
5260325f	71	int istate; /* input from channel (state of receive half) */
5260325f	72	int ostate; /* output to channel (state of transmit half) */
7e7327a1	73	int flags; /* close sent/rcvd */
7368a6c8	74	int rfd; /* read fd */
	75	int wfd; /* write fd */
	76	int efd; /* extended fd */
	77	int sock; /* sock fd */
0ae4fe1d	78	int isatty; /* rfd is a tty */
639cb8ab	79	int force_drain; /* force close on iEOF */
639cb8ab	80	int delayed; /* fdset hack */
5260325f	81	Buffer input; /* data read from socket, to be sent over
	82	* encrypted connection */
	83	Buffer output; /* data received over encrypted connection for
	84	* send on socket */
7368a6c8	85	Buffer extended;
719fc62f	86	char path[SSH_CHANNEL_PATH_LEN];
719fc62f	87	/* path for unix domain sockets, or host name for forwards */
5260325f	88	int listening_port; /* port being listened for forwards */
	89	int host_port; /* remote port to connect for forwards */
	90	char remote_name; / remote hostname */
7368a6c8	91
	92	int remote_window;
	93	int remote_maxpacket;
	94	int local_window;
	95	int local_window_max;
	96	int local_consumed;
	97	int local_maxpacket;
	98	int extended_usage;
	99
	100	char ctype; / type */
	101
1d1ffb87	102	/* callback */
7368a6c8	103	channel_callback_fn *cb_fn;
	104	void *cb_arg;
	105	int cb_event;
3cf2be58	106	channel_callback_fn *detach_user;
2e73a022	107
	108	/* filter */
	109	channel_filter_fn *input_filter;
	110	};
7368a6c8	111
	112	#define CHAN_EXTENDED_IGNORE 0
	113	#define CHAN_EXTENDED_READ 1
	114	#define CHAN_EXTENDED_WRITE 2
	115
bcbf86ec	116	/* default window/packet sizes for tcp/x11-fwd-channel */
	117	#define CHAN_SES_WINDOW_DEFAULT (32*1024)
	118	#define CHAN_SES_PACKET_DEFAULT (CHAN_SES_WINDOW_DEFAULT/2)
	119	#define CHAN_TCP_WINDOW_DEFAULT (32*1024)
	120	#define CHAN_TCP_PACKET_DEFAULT (CHAN_TCP_WINDOW_DEFAULT/2)
	121	#define CHAN_X11_WINDOW_DEFAULT (4*1024)
	122	#define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2)
	123
8e7895b8	124	/* possible input states */
	125	#define CHAN_INPUT_OPEN 0x01
	126	#define CHAN_INPUT_WAIT_DRAIN 0x02
	127	#define CHAN_INPUT_WAIT_OCLOSE 0x04
	128	#define CHAN_INPUT_CLOSED 0x08
bcbf86ec	129
8e7895b8	130	/* possible output states */
	131	#define CHAN_OUTPUT_OPEN 0x10
	132	#define CHAN_OUTPUT_WAIT_DRAIN 0x20
	133	#define CHAN_OUTPUT_WAIT_IEOF 0x40
	134	#define CHAN_OUTPUT_CLOSED 0x80
	135
	136	#define CHAN_CLOSE_SENT 0x01
	137	#define CHAN_CLOSE_RCVD 0x02
	138
8e7895b8	139	/* channel management */
8e7895b8	140
2a1e4639	141	Channel *channel_lookup(int);
2a1e4639	142	Channel channel_new(char , int, int, int, int, int, int, int, char *, int);
255cabd9	143	void channel_set_fds(int, int, int, int, int, int);
3cf2be58	144	void channel_free(Channel *);
3cf2be58	145	void channel_free_all(void);
3cf2be58	146	void channel_stop_listening(void);
255cabd9	147
	148	void channel_send_open(int);
	149	void channel_request(int, char *, int);
	150	void channel_request_start(int, char *, int);
	151	void channel_register_callback(int, int mtype, channel_callback_fn , void );
	152	void channel_register_cleanup(int, channel_callback_fn *);
	153	void channel_register_filter(int, channel_filter_fn *);
	154	void channel_cancel_cleanup(int);
489aa2e9	155	int channel_close_fd(int *);
7368a6c8	156
8e7895b8	157	/* protocol handler */
7368a6c8	158
255cabd9	159	void channel_input_channel_request(int, int, void *);
	160	void channel_input_close(int, int, void *);
	161	void channel_input_close_confirmation(int, int, void *);
	162	void channel_input_data(int, int, void *);
	163	void channel_input_extended_data(int, int, void *);
	164	void channel_input_ieof(int, int, void *);
	165	void channel_input_oclose(int, int, void *);
	166	void channel_input_open_confirmation(int, int, void *);
	167	void channel_input_open_failure(int, int, void *);
	168	void channel_input_port_open(int, int, void *);
	169	void channel_input_window_adjust(int, int, void *);
7368a6c8	170
8e7895b8	171	/* file descriptor handling (read/write) */
7368a6c8	172
489aa2e9	173	void channel_prepare_select(fd_set , fd_set , int , int, int);
255cabd9	174	void channel_after_select(fd_set , fd_set );
255cabd9	175	void channel_output_poll(void);
7368a6c8	176
255cabd9	177	int channel_not_very_much_buffered_data(void);
255cabd9	178	void channel_close_all(void);
255cabd9	179	int channel_still_open(void);
	180	char *channel_open_message(void);
	181	int channel_find_open(void);
7368a6c8	182
5e4a7219	183	/* tcp forwarding */
5e4a7219	184	void channel_set_af(int af);
255cabd9	185	void channel_permit_all_opens(void);
	186	void channel_add_permitted_opens(char *, int);
	187	void channel_clear_permitted_opens(void);
	188	void channel_input_port_forward_request(int, int);
	189	int channel_connect_to(const char *, u_short);
b3f8a79c	190	int channel_connect_by_listen_address(u_short);
255cabd9	191	void channel_request_remote_forwarding(u_short, const char *, u_short);
255cabd9	192	int channel_request_local_forwarding(u_short, const char *, u_short, int);
02a024dd	193	int
2a1e4639	194	channel_request_forwarding(const char , u_short, const char , u_short, int,
2a1e4639	195	int);
7368a6c8	196
8e7895b8	197	/* x11 forwarding */
7368a6c8	198
255cabd9	199	int x11_connect_display(void);
	200	char *x11_create_display(int);
	201	char *x11_create_display_inet(int, int);
	202	void x11_input_open(int, int, void *);
	203	void x11_request_forwarding(void);
	204	void x11_request_forwarding_with_spoofing(int, const char , const char );
	205	void deny_input_open(int, int, void *);
7368a6c8	206
8e7895b8	207	/* agent forwarding */
7368a6c8	208
255cabd9	209	void auth_request_forwarding(void);
	210	char *auth_get_socket_name(void);
	211	void auth_sock_cleanup_proc(void *);
	212	int auth_input_request_forwarding(struct passwd *);
	213	void auth_input_open_request(int, int, void *);
7368a6c8	214
8e7895b8	215	/* channel close */
7e7327a1	216
255cabd9	217	int chan_is_dead(Channel *);
	218	void chan_mark_dead(Channel *);
	219	void chan_init_iostates(Channel *);
	220	void chan_init(void);
	221
2a1e4639	222	typedef void chan_event_fn(Channel *);
8e7895b8	223
	224	/* for the input state */
	225	extern chan_event_fn *chan_rcvd_oclose;
	226	extern chan_event_fn *chan_read_failed;
	227	extern chan_event_fn *chan_ibuf_empty;
	228
	229	/* for the output state */
	230	extern chan_event_fn *chan_rcvd_ieof;
	231	extern chan_event_fn *chan_write_failed;
	232	extern chan_event_fn *chan_obuf_empty;
	233
8efc0c15	234	#endif