[openssh.git] / nchan.h

/*
 * Copyright (c) 1999 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Markus Friedl.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * 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("$Id$"); */

#ifndef NCHAN_H
#define NCHAN_H

/*
 * SSH Protocol 1.5 aka New Channel Protocol
 * Thanks to Martina, Axel and everyone who left Erlangen, leaving me bored.
 * Written by Markus Friedl in October 1999
 *
 * Protocol versions 1.3 and 1.5 differ in the handshake protocol used for the
 * tear down of channels:
 *
 * 1.3:	strict request-ack-protocol:
 * 	CLOSE	->
 * 		<-  CLOSE_CONFIRM
 *
 * 1.5:	uses variations of:
 * 	IEOF	->
 * 		<-  OCLOSE
 * 		<-  IEOF
 * 	OCLOSE	->
 * 	i.e. both sides have to close the channel
 *
 * See the debugging output from 'ssh -v' and 'sshd -d' of
 * ssh-1.2.27 as an example.
 *
 */

/* ssh-proto-1.5 overloads prot-1.3-message-types */
#define SSH_MSG_CHANNEL_INPUT_EOF	SSH_MSG_CHANNEL_CLOSE
#define SSH_MSG_CHANNEL_OUTPUT_CLOSE	SSH_MSG_CHANNEL_CLOSE_CONFIRMATION

/* 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

/* EVENTS for the input state */
void    chan_rcvd_oclose(Channel * c);
void    chan_read_failed(Channel * c);
void    chan_ibuf_empty(Channel * c);

/* EVENTS for the output state */
void    chan_rcvd_ieof(Channel * c);
void    chan_write_failed(Channel * c);
void    chan_obuf_empty(Channel * c);

void    chan_init_iostates(Channel * c);
#endif
Commit	Line	Data
aa3378df	1	/*
	2	* Copyright (c) 1999 Markus Friedl. All rights reserved.
	3	*
	4	* Redistribution and use in source and binary forms, with or without
	5	* modification, are permitted provided that the following conditions
	6	* are met:
	7	* 1. Redistributions of source code must retain the above copyright
	8	* notice, this list of conditions and the following disclaimer.
	9	* 2. Redistributions in binary form must reproduce the above copyright
	10	* notice, this list of conditions and the following disclaimer in the
	11	* documentation and/or other materials provided with the distribution.
	12	* 3. All advertising materials mentioning features or use of this software
	13	* must display the following acknowledgement:
	14	* This product includes software developed by Markus Friedl.
	15	* 4. The name of the author may not be used to endorse or promote products
	16	* derived from this software without specific prior written permission.
	17	*
	18	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	19	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	20	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	21	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	22	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	23	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	24	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	25	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	26	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	27	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	28	*/
	29
8efc0c15	30	/* RCSID("$Id$"); */
	31
	32	#ifndef NCHAN_H
	33	#define NCHAN_H
	34
	35	/*
	36	* SSH Protocol 1.5 aka New Channel Protocol
	37	* Thanks to Martina, Axel and everyone who left Erlangen, leaving me bored.
	38	* Written by Markus Friedl in October 1999
5260325f	39	*
8efc0c15	40	* Protocol versions 1.3 and 1.5 differ in the handshake protocol used for the
8efc0c15	41	* tear down of channels:
5260325f	42	*
8efc0c15	43	* 1.3: strict request-ack-protocol:
	44	* CLOSE ->
	45	* <- CLOSE_CONFIRM
5260325f	46	*
8efc0c15	47	* 1.5: uses variations of:
	48	* IEOF ->
	49	* <- OCLOSE
	50	* <- IEOF
	51	* OCLOSE ->
	52	* i.e. both sides have to close the channel
5260325f	53	*
8efc0c15	54	* See the debugging output from 'ssh -v' and 'sshd -d' of
8efc0c15	55	* ssh-1.2.27 as an example.
5260325f	56	*
8efc0c15	57	*/
	58
	59	/* ssh-proto-1.5 overloads prot-1.3-message-types */
	60	#define SSH_MSG_CHANNEL_INPUT_EOF SSH_MSG_CHANNEL_CLOSE
	61	#define SSH_MSG_CHANNEL_OUTPUT_CLOSE SSH_MSG_CHANNEL_CLOSE_CONFIRMATION
	62
	63	/* possible input states */
	64	#define CHAN_INPUT_OPEN 0x01
	65	#define CHAN_INPUT_WAIT_DRAIN 0x02
	66	#define CHAN_INPUT_WAIT_OCLOSE 0x04
	67	#define CHAN_INPUT_CLOSED 0x08
	68
	69	/* possible output states */
	70	#define CHAN_OUTPUT_OPEN 0x10
	71	#define CHAN_OUTPUT_WAIT_DRAIN 0x20
	72	#define CHAN_OUTPUT_WAIT_IEOF 0x40
	73	#define CHAN_OUTPUT_CLOSED 0x80
	74
	75	/* EVENTS for the input state */
5260325f	76	void chan_rcvd_oclose(Channel * c);
	77	void chan_read_failed(Channel * c);
	78	void chan_ibuf_empty(Channel * c);
8efc0c15	79
8efc0c15	80	/* EVENTS for the output state */
5260325f	81	void chan_rcvd_ieof(Channel * c);
	82	void chan_write_failed(Channel * c);
	83	void chan_obuf_empty(Channel * c);
8efc0c15	84
5260325f	85	void chan_init_iostates(Channel * c);
8efc0c15	86	#endif