dropbear: channel.h annotate

annotate channel.h @ 783:34e69908b3f7

Use '#' for host#port separator, document it. This fixes scp in multihop

author	Matt Johnston <matt@ucc.asn.au>
date	Wed, 17 Apr 2013 22:48:43 +0800
parents	4a274f47eabd
children	4ad38e223ccd

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 /* channel->type values */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	33 #define CHANNEL_ID_NONE 0
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	34 #define CHANNEL_ID_SESSION 1
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	35 #define CHANNEL_ID_X11 2
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	36 #define CHANNEL_ID_AGENT 3
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	37 #define CHANNEL_ID_TCPDIRECT 4
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	38 #define CHANNEL_ID_TCPFORWARDED 5
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	39
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	40 #define SSH_OPEN_ADMINISTRATIVELY_PROHIBITED 1
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	41 #define SSH_OPEN_CONNECT_FAILED 2
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	42 #define SSH_OPEN_UNKNOWN_CHANNEL_TYPE 3
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	43 #define SSH_OPEN_RESOURCE_SHORTAGE 4
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	44
70 b0316ce64e4b Merging in the changes from 0.41-0.43 main Dropbear tree Matt Johnston <matt@ucc.asn.au> parents: 13 diff changeset	45 /* 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	46 #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	47
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	48 #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	49
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	50 struct ChanType;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	51
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	52 struct Channel {
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	53
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	54 unsigned int index; /* the local channel index */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	55 unsigned int remotechan;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	56 unsigned int recvwindow, transwindow;
108 10f4d3319780 - added circular buffering for channels Matt Johnston <matt@ucc.asn.au> parents: 107 diff changeset	57 unsigned int recvdonelen;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	58 unsigned int recvmaxpacket, transmaxpacket;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	59 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	60 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	61 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	62 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	63 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	64 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	65 initially NULL */
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	66 circbuffer extrabuf; / extended-data for the program - used like writebuf
d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	67 but for stderr */
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	68
359 78518751cb82 just shuffle some variables names about, a brief comment Matt Johnston <matt@ucc.asn.au> parents: 253 diff changeset	69 /* 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	70 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	71 int recv_eof, sent_eof;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	72
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	73 /* 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	74 * 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	75 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	76
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	77 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	78 fully initialised */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	79
243 0056419cf0f4 * ensure that we only handle open confirmation/failure Matt Johnston <matt@ucc.asn.au> parents: 240 diff changeset	80 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	81 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	82 or failure). */
0056419cf0f4 * ensure that we only handle open confirmation/failure Matt Johnston <matt@ucc.asn.au> parents: 240 diff changeset	83
416 a01c0c8e543a Improve behaviour when flushing out after a process has exited. Matt Johnston <matt@ucc.asn.au> parents: 359 diff changeset	84 int flushing;
a01c0c8e543a Improve behaviour when flushing out after a process has exited. Matt Johnston <matt@ucc.asn.au> parents: 359 diff changeset	85
722 4a274f47eabd Add ~. and ~^Z handling to exit/suspend dbclient Matt Johnston <matt@ucc.asn.au> parents: 707 diff changeset	86 /* 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	87 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	88
7 425ed5c20157 Chantype handling is sorted Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	89 const struct ChanType* type;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	90 };
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 struct ChanType {
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	93
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	94 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	95 char *name;
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	96 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	97 int (check_close)(struct Channel);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	98 void (reqhandler)(struct Channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	99 void (closehandler)(struct Channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	100
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();
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	108
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	109 void recv_msg_channel_open();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	110 void recv_msg_channel_request();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	111 void send_msg_channel_failure(struct Channel *channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	112 void send_msg_channel_success(struct Channel *channel);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	113 void recv_msg_channel_data();
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	114 void recv_msg_channel_extended_data();
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	115 void recv_msg_channel_window_adjust();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	116 void recv_msg_channel_close();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	117 void recv_msg_channel_eof();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	118
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	119 void common_recv_msg_channel_data(struct Channel *channel, int fd,
d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	120 circbuffer * buf);
d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	121
150 82fcf3185616 Cleaning out various dead wood found with -dead_strip Matt Johnston <matt@ucc.asn.au> parents: 124 diff changeset	122 #ifdef DROPBEAR_CLIENT
226 9a9c6d633972 channel.h: make definition extern Matt Johnston <matt@ucc.asn.au> parents: 179 diff changeset	123 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	124 #endif
107 d3eb1fa8484e Nasty. Matt Johnston <matt@ucc.asn.au> parents: 70 diff changeset	125
156 8c2b3506f112 Rearrange preprocessor parts so that compilation with various options Matt Johnston <matt@ucc.asn.au> parents: 150 diff changeset	126 #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	127 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	128 void recv_msg_channel_open_confirmation();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	129 void recv_msg_channel_open_failure();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	130 #endif
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	131
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	132 #endif /* _CHANNEL_H_ */

Mercurial > dropbear

annotate channel.h @ 783:34e69908b3f7