network.h

   1 /*
   2  * Networking abstraction in PuTTY.
   3  *
   4  * The way this works is: a back end can choose to open any number
   5  * of sockets - including zero, which might be necessary in some.
   6  * It can register a bunch of callbacks (most notably for when
   7  * data is received) for each socket, and it can call the networking
   8  * abstraction to send data without having to worry about blocking.
   9  * The stuff behind the abstraction takes care of selects and
  10  * nonblocking writes and all that sort of painful gubbins.
  11  */
  12
  13 #ifndef PUTTY_NETWORK_H
  14 #define PUTTY_NETWORK_H
  15
  16 #ifndef DONE_TYPEDEFS
  17 #define DONE_TYPEDEFS
  18 typedef struct conf_tag Conf;
  19 typedef struct backend_tag Backend;
  20 typedef struct terminal_tag Terminal;
  21 #endif
  22
  23 typedef struct SockAddr_tag *SockAddr;
  24 /* pay attention to levels of indirection */
  25 typedef struct socket_function_table **Socket;
  26 typedef struct plug_function_table **Plug;
  27
  28 struct socket_function_table {
  29     Plug(*plug) (Socket s, Plug p);
  30     /* use a different plug (return the old one) */
  31     /* if p is NULL, it doesn't change the plug */
  32     /* but it does return the one it's using */
  33     void (*close) (Socket s);
  34     int (*write) (Socket s, const char *data, int len);
  35     int (*write_oob) (Socket s, const char *data, int len);
  36     void (*write_eof) (Socket s);
  37     void (*flush) (Socket s);
  38     void (*set_frozen) (Socket s, int is_frozen);
  39     /* ignored by tcp, but vital for ssl */
  40     const char *(*socket_error) (Socket s);
  41     char *(*peer_info) (Socket s);
  42 };
  43
  44 typedef union { void *p; int i; } accept_ctx_t;
  45 typedef Socket (*accept_fn_t)(accept_ctx_t ctx, Plug plug);
  46
  47 struct plug_function_table {
  48     void (*log)(Plug p, int type, SockAddr addr, int port,
  49                 const char *error_msg, int error_code);
  50     /*
  51      * Passes the client progress reports on the process of setting
  52      * up the connection.
  53      *
  54      *  - type==0 means we are about to try to connect to address
  55      *    `addr' (error_msg and error_code are ignored)
  56      *  - type==1 means we have failed to connect to address `addr'
  57      *    (error_msg and error_code are supplied). This is not a
  58      *    fatal error - we may well have other candidate addresses
  59      *    to fall back to. When it _is_ fatal, the closing()
  60      *    function will be called.
  61      */
  62     int (*closing)
  63      (Plug p, const char *error_msg, int error_code, int calling_back);
  64     /* error_msg is NULL iff it is not an error (ie it closed normally) */
  65     /* calling_back != 0 iff there is a Plug function */
  66     /* currently running (would cure the fixme in try_send()) */
  67     int (*receive) (Plug p, int urgent, char *data, int len);
  68     /*
  69      *  - urgent==0. `data' points to `len' bytes of perfectly
  70      *    ordinary data.
  71      *
  72      *  - urgent==1. `data' points to `len' bytes of data,
  73      *    which were read from before an Urgent pointer.
  74      *
  75      *  - urgent==2. `data' points to `len' bytes of data,
  76      *    the first of which was the one at the Urgent mark.
  77      */
  78     void (*sent) (Plug p, int bufsize);
  79     /*
  80      * The `sent' function is called when the pending send backlog
  81      * on a socket is cleared or partially cleared. The new backlog
  82      * size is passed in the `bufsize' parameter.
  83      */
  84     int (*accepting)(Plug p, accept_fn_t constructor, accept_ctx_t ctx);
  85     /*
  86      * `accepting' is called only on listener-type sockets, and is
  87      * passed a constructor function+context that will create a fresh
  88      * Socket describing the connection. It returns nonzero if it
  89      * doesn't want the connection for some reason, or 0 on success.
  90      */
  91 };
  92
  93 /* proxy indirection layer */
  94 /* NB, control of 'addr' is passed via new_connection, which takes
  95  * responsibility for freeing it */
  96 Socket new_connection(SockAddr addr, const char *hostname,
  97                       int port, int privport,
  98                       int oobinline, int nodelay, int keepalive,
  99                       Plug plug, Conf *conf);
 100 Socket new_listener(const char *srcaddr, int port, Plug plug,
 101                     int local_host_only, Conf *conf, int addressfamily);
 102 SockAddr name_lookup(const char *host, int port, char **canonicalname,
 103                      Conf *conf, int addressfamily, void *frontend_for_logging,
 104                      const char *lookup_reason_for_logging);
 105 int proxy_for_destination (SockAddr addr, const char *hostname, int port,
 106                            Conf *conf);
 107
 108 /* platform-dependent callback from new_connection() */
 109 /* (same caveat about addr as new_connection()) */
 110 Socket platform_new_connection(SockAddr addr, const char *hostname,
 111                                int port, int privport,
 112                                int oobinline, int nodelay, int keepalive,
 113                                Plug plug, Conf *conf);
 114
 115 /* socket functions */
 116
 117 void sk_init(void);                    /* called once at program startup */
 118 void sk_cleanup(void);                 /* called just before program exit */
 119
 120 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family);
 121 SockAddr sk_nonamelookup(const char *host);
 122 void sk_getaddr(SockAddr addr, char *buf, int buflen);
 123 int sk_addr_needs_port(SockAddr addr);
 124 int sk_hostname_is_local(const char *name);
 125 int sk_address_is_local(SockAddr addr);
 126 int sk_address_is_special_local(SockAddr addr);
 127 int sk_addrtype(SockAddr addr);
 128 void sk_addrcopy(SockAddr addr, char *buf);
 129 void sk_addr_free(SockAddr addr);
 130 /* sk_addr_dup generates another SockAddr which contains the same data
 131  * as the original one and can be freed independently. May not actually
 132  * physically _duplicate_ it: incrementing a reference count so that
 133  * one more free is required before it disappears is an acceptable
 134  * implementation. */
 135 SockAddr sk_addr_dup(SockAddr addr);
 136
 137 /* NB, control of 'addr' is passed via sk_new, which takes responsibility
 138  * for freeing it, as for new_connection() */
 139 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 140               int nodelay, int keepalive, Plug p);
 141
 142 Socket sk_newlistener(const char *srcaddr, int port, Plug plug,
 143                       int local_host_only, int address_family);
 144
 145 #define sk_plug(s,p) (((*s)->plug) (s, p))
 146 #define sk_close(s) (((*s)->close) (s))
 147 #define sk_write(s,buf,len) (((*s)->write) (s, buf, len))
 148 #define sk_write_oob(s,buf,len) (((*s)->write_oob) (s, buf, len))
 149 #define sk_write_eof(s) (((*s)->write_eof) (s))
 150 #define sk_flush(s) (((*s)->flush) (s))
 151
 152 #ifdef DEFINE_PLUG_METHOD_MACROS
 153 #define plug_log(p,type,addr,port,msg,code) (((*p)->log) (p, type, addr, port, msg, code))
 154 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))
 155 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))
 156 #define plug_sent(p,bufsize) (((*p)->sent) (p, bufsize))
 157 #define plug_accepting(p, constructor, ctx) (((*p)->accepting)(p, constructor, ctx))
 158 #endif
 159
 160 /*
 161  * Special error values are returned from sk_namelookup and sk_new
 162  * if there's a problem. These functions extract an error message,
 163  * or return NULL if there's no problem.
 164  */
 165 const char *sk_addr_error(SockAddr addr);
 166 #define sk_socket_error(s) (((*s)->socket_error) (s))
 167
 168 /*
 169  * Set the `frozen' flag on a socket. A frozen socket is one in
 170  * which all READABLE notifications are ignored, so that data is
 171  * not accepted from the peer until the socket is unfrozen. This
 172  * exists for two purposes:
 173  *
 174  *  - Port forwarding: when a local listening port receives a
 175  *    connection, we do not want to receive data from the new
 176  *    socket until we have somewhere to send it. Hence, we freeze
 177  *    the socket until its associated SSH channel is ready; then we
 178  *    unfreeze it and pending data is delivered.
 179  *
 180  *  - Socket buffering: if an SSH channel (or the whole connection)
 181  *    backs up or presents a zero window, we must freeze the
 182  *    associated local socket in order to avoid unbounded buffer
 183  *    growth.
 184  */
 185 #define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen))
 186
 187 /*
 188  * Return a (dynamically allocated) string giving some information
 189  * about the other end of the socket, suitable for putting in log
 190  * files. May be NULL if nothing is available at all.
 191  */
 192 #define sk_peer_info(s) (((*s)->peer_info) (s))
 193
 194 /*
 195  * Simple wrapper on getservbyname(), needed by ssh.c. Returns the
 196  * port number, in host byte order (suitable for printf and so on).
 197  * Returns 0 on failure. Any platform not supporting getservbyname
 198  * can just return 0 - this function is not required to handle
 199  * numeric port specifications.
 200  */
 201 int net_service_lookup(char *service);
 202
 203 /*
 204  * Look up the local hostname; return value needs freeing.
 205  * May return NULL.
 206  */
 207 char *get_hostname(void);
 208
 209 /*
 210  * Trivial socket implementation which just stores an error. Found in
 211  * errsock.c.
 212  */
 213 Socket new_error_socket(const char *errmsg, Plug plug);
 214
 215 /* ----------------------------------------------------------------------
 216  * Functions defined outside the network code, which have to be
 217  * declared in this header file rather than the main putty.h because
 218  * they use types defined here.
 219  */
 220
 221 /*
 222  * Exports from be_misc.c.
 223  */
 224 void backend_socket_log(void *frontend, int type, SockAddr addr, int port,
 225                         const char *error_msg, int error_code);
 226
 227 #endif