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 config_tag Config;
  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 #ifndef OSSOCKET_DEFINED
  29 typedef void *OSSocket;
  30 #endif
  31
  32 struct socket_function_table {
  33     Plug(*plug) (Socket s, Plug p);
  34     /* use a different plug (return the old one) */
  35     /* if p is NULL, it doesn't change the plug */
  36     /* but it does return the one it's using */
  37     void (*close) (Socket s);
  38     int (*write) (Socket s, const char *data, int len);
  39     int (*write_oob) (Socket s, const char *data, int len);
  40     void (*flush) (Socket s);
  41     void (*set_private_ptr) (Socket s, void *ptr);
  42     void *(*get_private_ptr) (Socket s);
  43     void (*set_frozen) (Socket s, int is_frozen);
  44     /* ignored by tcp, but vital for ssl */
  45     const char *(*socket_error) (Socket s);
  46 };
  47
  48 struct plug_function_table {
  49     int (*closing)
  50      (Plug p, const char *error_msg, int error_code, int calling_back);
  51     /* error_msg is NULL iff it is not an error (ie it closed normally) */
  52     /* calling_back != 0 iff there is a Plug function */
  53     /* currently running (would cure the fixme in try_send()) */
  54     int (*receive) (Plug p, int urgent, char *data, int len);
  55     /*
  56      *  - urgent==0. `data' points to `len' bytes of perfectly
  57      *    ordinary data.
  58      *
  59      *  - urgent==1. `data' points to `len' bytes of data,
  60      *    which were read from before an Urgent pointer.
  61      *
  62      *  - urgent==2. `data' points to `len' bytes of data,
  63      *    the first of which was the one at the Urgent mark.
  64      */
  65     void (*sent) (Plug p, int bufsize);
  66     /*
  67      * The `sent' function is called when the pending send backlog
  68      * on a socket is cleared or partially cleared. The new backlog
  69      * size is passed in the `bufsize' parameter.
  70      */
  71     int (*accepting)(Plug p, OSSocket sock);
  72     /*
  73      * returns 0 if the host at address addr is a valid host for connecting or error
  74      */
  75 };
  76
  77 /* proxy indirection layer */
  78 /* NB, control of 'addr' is passed via new_connection, which takes
  79  * responsibility for freeing it */
  80 Socket new_connection(SockAddr addr, char *hostname,
  81                       int port, int privport,
  82                       int oobinline, int nodelay, int keepalive,
  83                       Plug plug, const Config *cfg);
  84 Socket new_listener(char *srcaddr, int port, Plug plug, int local_host_only,
  85                     const Config *cfg, int addressfamily);
  86 SockAddr name_lookup(char *host, int port, char **canonicalname,
  87                      const Config *cfg, int addressfamily);
  88
  89 /* platform-dependent callback from new_connection() */
  90 /* (same caveat about addr as new_connection()) */
  91 Socket platform_new_connection(SockAddr addr, char *hostname,
  92                                int port, int privport,
  93                                int oobinline, int nodelay, int keepalive,
  94                                Plug plug, const Config *cfg);
  95
  96 /* socket functions */
  97
  98 void sk_init(void);                    /* called once at program startup */
  99 void sk_cleanup(void);                 /* called just before program exit */
 100
 101 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family);
 102 SockAddr sk_nonamelookup(const char *host);
 103 void sk_getaddr(SockAddr addr, char *buf, int buflen);
 104 int sk_hostname_is_local(char *name);
 105 int sk_address_is_local(SockAddr addr);
 106 int sk_addrtype(SockAddr addr);
 107 void sk_addrcopy(SockAddr addr, char *buf);
 108 void sk_addr_free(SockAddr addr);
 109
 110 /* NB, control of 'addr' is passed via sk_new, which takes responsibility
 111  * for freeing it, as for new_connection() */
 112 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 113               int nodelay, int keepalive, Plug p);
 114
 115 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int address_family);
 116
 117 Socket sk_register(OSSocket sock, Plug plug);
 118
 119 #define sk_plug(s,p) (((*s)->plug) (s, p))
 120 #define sk_close(s) (((*s)->close) (s))
 121 #define sk_write(s,buf,len) (((*s)->write) (s, buf, len))
 122 #define sk_write_oob(s,buf,len) (((*s)->write_oob) (s, buf, len))
 123 #define sk_flush(s) (((*s)->flush) (s))
 124
 125 #ifdef DEFINE_PLUG_METHOD_MACROS
 126 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))
 127 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))
 128 #define plug_sent(p,bufsize) (((*p)->sent) (p, bufsize))
 129 #define plug_accepting(p, sock) (((*p)->accepting)(p, sock))
 130 #endif
 131
 132 /*
 133  * Each socket abstraction contains a `void *' private field in
 134  * which the client can keep state.
 135  *
 136  * This is perhaps unnecessary now that we have the notion of a plug,
 137  * but there is some existing code that uses it, so it stays.
 138  */
 139 #define sk_set_private_ptr(s, ptr) (((*s)->set_private_ptr) (s, ptr))
 140 #define sk_get_private_ptr(s) (((*s)->get_private_ptr) (s))
 141
 142 /*
 143  * Special error values are returned from sk_namelookup and sk_new
 144  * if there's a problem. These functions extract an error message,
 145  * or return NULL if there's no problem.
 146  */
 147 const char *sk_addr_error(SockAddr addr);
 148 #define sk_socket_error(s) (((*s)->socket_error) (s))
 149
 150 /*
 151  * Set the `frozen' flag on a socket. A frozen socket is one in
 152  * which all READABLE notifications are ignored, so that data is
 153  * not accepted from the peer until the socket is unfrozen. This
 154  * exists for two purposes:
 155  *
 156  *  - Port forwarding: when a local listening port receives a
 157  *    connection, we do not want to receive data from the new
 158  *    socket until we have somewhere to send it. Hence, we freeze
 159  *    the socket until its associated SSH channel is ready; then we
 160  *    unfreeze it and pending data is delivered.
 161  *
 162  *  - Socket buffering: if an SSH channel (or the whole connection)
 163  *    backs up or presents a zero window, we must freeze the
 164  *    associated local socket in order to avoid unbounded buffer
 165  *    growth.
 166  */
 167 #define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen))
 168
 169 /*
 170  * Call this after an operation that might have tried to send on a
 171  * socket, to clean up any pending network errors.
 172  */
 173 void net_pending_errors(void);
 174
 175 /*
 176  * Simple wrapper on getservbyname(), needed by ssh.c. Returns the
 177  * port number, in host byte order (suitable for printf and so on).
 178  * Returns 0 on failure. Any platform not supporting getservbyname
 179  * can just return 0 - this function is not required to handle
 180  * numeric port specifications.
 181  */
 182 int net_service_lookup(char *service);
 183
 184 /********** SSL stuff **********/
 185
 186 /*
 187  * This section is subject to change, but you get the general idea
 188  * of what it will eventually look like.
 189  */
 190
 191 typedef struct certificate *Certificate;
 192 typedef struct our_certificate *Our_Certificate;
 193     /* to be defined somewhere else, somehow */
 194
 195 typedef struct ssl_client_socket_function_table **SSL_Client_Socket;
 196 typedef struct ssl_client_plug_function_table **SSL_Client_Plug;
 197
 198 struct ssl_client_socket_function_table {
 199     struct socket_function_table base;
 200     void (*renegotiate) (SSL_Client_Socket s);
 201     /* renegotiate the cipher spec */
 202 };
 203
 204 struct ssl_client_plug_function_table {
 205     struct plug_function_table base;
 206     int (*refuse_cert) (SSL_Client_Plug p, Certificate cert[]);
 207     /* do we accept this certificate chain?  If not, why not? */
 208     /* cert[0] is the server's certificate, cert[] is NULL-terminated */
 209     /* the last certificate may or may not be the root certificate */
 210      Our_Certificate(*client_cert) (SSL_Client_Plug p);
 211     /* the server wants us to identify ourselves */
 212     /* may return NULL if we want anonymity */
 213 };
 214
 215 SSL_Client_Socket sk_ssl_client_over(Socket s,  /* pre-existing (tcp) connection */
 216                                      SSL_Client_Plug p);
 217
 218 #define sk_renegotiate(s) (((*s)->renegotiate) (s))
 219
 220 #endif