dropbear: channel.h annotate

annotate channel.h @ 970:0bb16232e7c4

Make keepalive handling more robust, this should now match what OpenSSH does

author	Matt Johnston <matt@ucc.asn.au>
date	Tue, 19 Aug 2014 23:08:56 +0800
parents	5daedffd0769
children	02baa0b334e8 deed0571cacc

rev	line source
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1 /*
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2 * Dropbear - a SSH2 server
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	3 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	4 * Copyright (c) 2002,2003 Matt Johnston
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	5 * All rights reserved.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	6 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	7 * Permission is hereby granted, free of charge, to any person obtaining a copy
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	8 * of this software and associated documentation files (the "Software"), to deal
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	9 * in the Software without restriction, including without limitation the rights
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	11 * copies of the Software, and to permit persons to whom the Software is
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	12 * furnished to do so, subject to the following conditions:
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	13 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	14 * The above copyright notice and this permission notice shall be included in
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	15 * all copies or substantial portions of the Software.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	16 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	23 * SOFTWARE. */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	24
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	25 #ifndef _CHANNEL_H_
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	26 #define _CHANNEL_H_
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	27
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	28 #include "includes.h"
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	29 #include "buffer.h"
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	30 #include "circbuffer.h"
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	31
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	32 #define SSH_OPEN_ADMINISTRATIVELY_PROHIBITED 1
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	33 #define SSH_OPEN_CONNECT_FAILED 2
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	34 #define SSH_OPEN_UNKNOWN_CHANNEL_TYPE 3
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	35 #define SSH_OPEN_RESOURCE_SHORTAGE 4
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	36
70 b0316ce64e4b Merging in the changes from 0.41-0.43 main Dropbear tree Matt Johnston <matt@ucc.asn.au> parents: 13 diff changeset	37 /* Not a real type */
b0316ce64e4b Merging in the changes from 0.41-0.43 main Dropbear tree Matt Johnston <matt@ucc.asn.au> parents: 13 diff changeset	38 #define SSH_OPEN_IN_PROGRESS 99
b0316ce64e4b Merging in the changes from 0.41-0.43 main Dropbear tree Matt Johnston <matt@ucc.asn.au> parents: 13 diff changeset	39
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	40 #define CHAN_EXTEND_SIZE 3 /* how many extra slots to add when we need more */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	41
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	42 struct ChanType;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	43
941 5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	44 enum dropbear_channel_prio {
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	45 DROPBEAR_CHANNEL_PRIO_INTERACTIVE, /* pty shell, x11 */
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	46 DROPBEAR_CHANNEL_PRIO_UNKNOWABLE, /* tcp - can't know what's being forwarded */
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	47 DROPBEAR_CHANNEL_PRIO_BULK, /* the rest - probably scp or something */
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	48 DROPBEAR_CHANNEL_PRIO_EARLY, /* channel is still being set up */
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	49 };
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	50
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	51 struct Channel {
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	52
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	53 unsigned int index; /* the local channel index */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	54 unsigned int remotechan;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	55 unsigned int recvwindow, transwindow;
108 10f4d3319780 - added circular buffering for channels Matt Johnston <matt@ucc.asn.au> parents: 107 diff changeset	56 unsigned int recvdonelen;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	57 unsigned int recvmaxpacket, transmaxpacket;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	58 void* typedata; /* a pointer to type specific data */
253 84925eceeb13 * rename infd/outfd to writefd/readfd, to avoid confusion Matt Johnston <matt@ucc.asn.au> parents: 243 diff changeset	59 int writefd; /* read from wire, written to insecure side */
547 cf376c696dfc Make it compile, update for changes in channel structure. Matt Johnston <matt@ucc.asn.au> parents: 448 diff changeset	60 int readfd; /* read from insecure side, written to wire */
253 84925eceeb13 * rename infd/outfd to writefd/readfd, to avoid confusion Matt Johnston <matt@ucc.asn.au> parents: 243 diff changeset	61 int errfd; /* used like writefd or readfd, depending if it's client or server.
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	62 Doesn't exactly belong here, but is cleaner here */
707 564e7f87ecc3 Fix memory leak when direct TCP connections time out on connection. Matt Johnston <matt@ucc.asn.au> parents: 652 diff changeset	63 circbuffer writebuf; / data from the wire, for local consumption. Can be
564e7f87ecc3 Fix memory leak when direct TCP connections time out on connection. Matt Johnston <matt@ucc.asn.au> parents: 652 diff changeset	64 initially NULL */
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	65 circbuffer extrabuf; / extended-data for the program - used like writebuf
d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	66 but for stderr */
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	67
359 78518751cb82 just shuffle some variables names about, a brief comment Matt Johnston <matt@ucc.asn.au> parents: 253 diff changeset	68 /* whether close/eof messages have been exchanged */
78518751cb82 just shuffle some variables names about, a brief comment Matt Johnston <matt@ucc.asn.au> parents: 253 diff changeset	69 int sent_close, recv_close;
78518751cb82 just shuffle some variables names about, a brief comment Matt Johnston <matt@ucc.asn.au> parents: 253 diff changeset	70 int recv_eof, sent_eof;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	71
652 17962b2a6b8f - Make sure we don't use channel-specific data after it has been freed Matt Johnston <matt@ucc.asn.au> parents: 547 diff changeset	72 /* Set after running the ChanType-specific close hander
17962b2a6b8f - Make sure we don't use channel-specific data after it has been freed Matt Johnston <matt@ucc.asn.au> parents: 547 diff changeset	73 * to ensure we don't run it twice (nor type->checkclose()). */
17962b2a6b8f - Make sure we don't use channel-specific data after it has been freed Matt Johnston <matt@ucc.asn.au> parents: 547 diff changeset	74 int close_handler_done;
17962b2a6b8f - Make sure we don't use channel-specific data after it has been freed Matt Johnston <matt@ucc.asn.au> parents: 547 diff changeset	75
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	76 int initconn; /* used for TCP forwarding, whether the channel has been
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	77 fully initialised */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	78
243 0056419cf0f4 * ensure that we only handle open confirmation/failure Matt Johnston <matt@ucc.asn.au> parents: 240 diff changeset	79 int await_open; /* flag indicating whether we've sent an open request
0056419cf0f4 * ensure that we only handle open confirmation/failure Matt Johnston <matt@ucc.asn.au> parents: 240 diff changeset	80 for this channel (and are awaiting a confirmation
0056419cf0f4 * ensure that we only handle open confirmation/failure Matt Johnston <matt@ucc.asn.au> parents: 240 diff changeset	81 or failure). */
0056419cf0f4 * ensure that we only handle open confirmation/failure Matt Johnston <matt@ucc.asn.au> parents: 240 diff changeset	82
416 a01c0c8e543a Improve behaviour when flushing out after a process has exited. Matt Johnston <matt@ucc.asn.au> parents: 359 diff changeset	83 int flushing;
a01c0c8e543a Improve behaviour when flushing out after a process has exited. Matt Johnston <matt@ucc.asn.au> parents: 359 diff changeset	84
722 4a274f47eabd Add ~. and ~^Z handling to exit/suspend dbclient Matt Johnston <matt@ucc.asn.au> parents: 707 diff changeset	85 /* Used by client chansession to handle ~ escaping, NULL ignored otherwise */
4a274f47eabd Add ~. and ~^Z handling to exit/suspend dbclient Matt Johnston <matt@ucc.asn.au> parents: 707 diff changeset	86 void (read_mangler)(struct Channel, unsigned char* bytes, int *len);
4a274f47eabd Add ~. and ~^Z handling to exit/suspend dbclient Matt Johnston <matt@ucc.asn.au> parents: 707 diff changeset	87
7 425ed5c20157 Chantype handling is sorted Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	88 const struct ChanType* type;
941 5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	89
5daedffd0769 Set tcp priority as follows: Matt Johnston <matt@ucc.asn.au> parents: 937 diff changeset	90 enum dropbear_channel_prio prio;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	91 };
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	92
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	93 struct ChanType {
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	94
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	95 int sepfds; /* Whether this channel has seperate pipes for in/out or not */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	96 char *name;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	97 int (inithandler)(struct Channel);
359 78518751cb82 just shuffle some variables names about, a brief comment Matt Johnston <matt@ucc.asn.au> parents: 253 diff changeset	98 int (check_close)(struct Channel);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	99 void (reqhandler)(struct Channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	100 void (closehandler)(struct Channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	101 };
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	102
240 581f81e8c50c common session initialiser doesn't need to call Matt Johnston <matt@ucc.asn.au> parents: 226 diff changeset	103 void chaninitialise(const struct ChanType *chantypes[]);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	104 void chancleanup();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	105 void setchannelfds(fd_set readfd, fd_set writefd);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	106 void channelio(fd_set readfd, fd_set writefd);
179 161557a9dde8 * fix longstanding bug with connections being closed on failure to Matt Johnston <matt@ucc.asn.au> parents: 156 diff changeset	107 struct Channel* getchannel();
970 0bb16232e7c4 Make keepalive handling more robust, this should now match what OpenSSH does Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	108 /* Returns an arbitrary channel that is in a ready state - not
0bb16232e7c4 Make keepalive handling more robust, this should now match what OpenSSH does Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	109 being initialised and no EOF in either direction. NULL if none. */
0bb16232e7c4 Make keepalive handling more robust, this should now match what OpenSSH does Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	110 struct Channel* get_any_ready_channel();
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	111
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	112 void recv_msg_channel_open();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	113 void recv_msg_channel_request();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	114 void send_msg_channel_failure(struct Channel *channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	115 void send_msg_channel_success(struct Channel *channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	116 void recv_msg_channel_data();
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	117 void recv_msg_channel_extended_data();
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	118 void recv_msg_channel_window_adjust();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	119 void recv_msg_channel_close();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	120 void recv_msg_channel_eof();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	121
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	122 void common_recv_msg_channel_data(struct Channel *channel, int fd,
d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	123 circbuffer * buf);
d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	124
150 82fcf3185616 Cleaning out various dead wood found with -dead_strip Matt Johnston <matt@ucc.asn.au> parents: 124 diff changeset	125 #ifdef DROPBEAR_CLIENT
226 9a9c6d633972 channel.h: make definition extern Matt Johnston <matt@ucc.asn.au> parents: 179 diff changeset	126 extern const struct ChanType clichansess;
150 82fcf3185616 Cleaning out various dead wood found with -dead_strip Matt Johnston <matt@ucc.asn.au> parents: 124 diff changeset	127 #endif
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	128
156 8c2b3506f112 Rearrange preprocessor parts so that compilation with various options Matt Johnston <matt@ucc.asn.au> parents: 150 diff changeset	129 #if defined(USING_LISTENERS) \|\| defined(DROPBEAR_CLIENT)
9 7f77962de998 - Reworked non-channel fd handling to listener.c Matt Johnston <matt@ucc.asn.au> parents: 7 diff changeset	130 int send_msg_channel_open_init(int fd, const struct ChanType *type);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	131 void recv_msg_channel_open_confirmation();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	132 void recv_msg_channel_open_failure();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	133 #endif
970 0bb16232e7c4 Make keepalive handling more robust, this should now match what OpenSSH does Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	134 void start_send_channel_request(struct Channel channel, unsigned char type);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	135
937 4ad38e223ccd Send a failure response if a client receives a global request Matt Johnston <matt@ucc.asn.au> parents: 722 diff changeset	136 void send_msg_request_success();
4ad38e223ccd Send a failure response if a client receives a global request Matt Johnston <matt@ucc.asn.au> parents: 722 diff changeset	137 void send_msg_request_failure();
4ad38e223ccd Send a failure response if a client receives a global request Matt Johnston <matt@ucc.asn.au> parents: 722 diff changeset	138
970 0bb16232e7c4 Make keepalive handling more robust, this should now match what OpenSSH does Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	139
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	140 #endif /* _CHANNEL_H_ */

Mercurial > dropbear

annotate channel.h @ 970:0bb16232e7c4