userapps/opensource/sshd/channel.h

   1 /*
   2  * Dropbear - a SSH2 server
   3  *
   4  * Copyright (c) 2002,2003 Matt Johnston
   5  * All rights reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE. */
  24
  25 #ifndef _CHANNEL_H_
  26 #define _CHANNEL_H_
  27
  28 #include "includes.h"
  29 #include "buffer.h"
  30 #include "circbuffer.h"
  31
  32 /* channel->type values */
  33 #define CHANNEL_ID_NONE 0
  34 #define CHANNEL_ID_SESSION 1
  35 #define CHANNEL_ID_X11 2
  36 #define CHANNEL_ID_AGENT 3
  37 #define CHANNEL_ID_TCPDIRECT 4
  38 #define CHANNEL_ID_TCPFORWARDED 5
  39
  40 #define SSH_OPEN_ADMINISTRATIVELY_PROHIBITED    1
  41 #define SSH_OPEN_CONNECT_FAILED                 2
  42 #define SSH_OPEN_UNKNOWN_CHANNEL_TYPE           3
  43 #define SSH_OPEN_RESOURCE_SHORTAGE              4
  44
  45 /* Not a real type */
  46 #define SSH_OPEN_IN_PROGRESS                                    99
  47
  48 #define MAX_CHANNELS 100 /* simple mem restriction, includes each tcp/x11
  49                                                         connection, so can't be _too_ small */
  50
  51 #define CHAN_EXTEND_SIZE 3 /* how many extra slots to add when we need more */
  52
  53 #define RECV_MAXWINDOW 8000 /* tweak */
  54 #define RECV_WINDOWEXTEND 1000 /* We send a "window extend" every
  55                                                                 RECV_WINDOWEXTEND bytes */
  56 #define RECV_MAXPACKET RECV_MAXWINDOW /* tweak */
  57
  58 struct ChanType;
  59
  60 struct Channel {
  61
  62         unsigned int index; /* the local channel index */
  63         unsigned int remotechan;
  64         unsigned int recvwindow, transwindow;
  65         unsigned int recvdonelen;
  66         unsigned int recvmaxpacket, transmaxpacket;
  67         void* typedata; /* a pointer to type specific data */
  68         int infd; /* data to send over the wire */
  69         int outfd; /* data for consumption, what was in writebuf */
  70         int errfd; /* used like infd or errfd, depending if it's client or server.
  71                                   Doesn't exactly belong here, but is cleaner here */
  72         circbuffer *writebuf; /* data from the wire, for local consumption */
  73         circbuffer *extrabuf; /* extended-data for the program - used like writebuf
  74                                              but for stderr */
  75
  76         int sentclosed, recvclosed;
  77
  78         /* this is set when we receive/send a channel eof packet */
  79         int recveof, senteof;
  80
  81         int initconn; /* used for TCP forwarding, whether the channel has been
  82                                          fully initialised */
  83
  84         const struct ChanType* type;
  85
  86 };
  87
  88 struct ChanType {
  89
  90         int sepfds; /* Whether this channel has seperate pipes for in/out or not */
  91         char *name;
  92         int (*inithandler)(struct Channel*);
  93         int (*checkclose)(struct Channel*);
  94         void (*reqhandler)(struct Channel*);
  95         void (*closehandler)(struct Channel*);
  96
  97 };
  98
  99 void chaninitialise();
 100 void chancleanup();
 101 void setchannelfds(fd_set *readfd, fd_set *writefd);
 102 void channelio(fd_set *readfd, fd_set *writefd);
 103 struct Channel* getchannel();
 104 struct Channel* newchannel(unsigned int remotechan,
 105                 const struct ChanType *type,
 106                 unsigned int transwindow, unsigned int transmaxpacket);
 107
 108 void recv_msg_channel_open();
 109 void recv_msg_channel_request();
 110 void send_msg_channel_failure(struct Channel *channel);
 111 void send_msg_channel_success(struct Channel *channel);
 112 void recv_msg_channel_data();
 113 void recv_msg_channel_extended_data();
 114 void recv_msg_channel_window_adjust();
 115 void recv_msg_channel_close();
 116 void recv_msg_channel_eof();
 117
 118 void common_recv_msg_channel_data(struct Channel *channel, int fd,
 119                 circbuffer * buf);
 120
 121 #ifdef DROPBEAR_CLIENT
 122 const struct ChanType clichansess;
 123 #endif
 124
 125 #if defined(USING_LISTENERS) || defined(DROPBEAR_CLIENT)
 126 int send_msg_channel_open_init(int fd, const struct ChanType *type);
 127 void recv_msg_channel_open_confirmation();
 128 void recv_msg_channel_open_failure();
 129 #endif
 130
 131 #endif /* _CHANNEL_H_ */