SSH port forwarding! How cool is that?
[u/mdw/putty] / network.h
index f8b81a3..e205b87 100644 (file)
--- a/network.h
+++ b/network.h
@@ -19,35 +19,39 @@ typedef struct socket_function_table **Socket;
 typedef struct plug_function_table **Plug;
 
 struct socket_function_table {
-    Plug (*plug) (Socket s, Plug p);
-       /* use a different plug (return the old one) */
-       /* if p is NULL, it doesn't change the plug */
-       /* but it does return the one it's using */
+    Plug(*plug) (Socket s, Plug p);
+    /* use a different plug (return the old one) */
+    /* if p is NULL, it doesn't change the plug */
+    /* but it does return the one it's using */
     void (*close) (Socket s);
     void (*write) (Socket s, char *data, int len);
     void (*write_oob) (Socket s, char *data, int len);
     void (*flush) (Socket s);
-       /* ignored by tcp, but vital for ssl */
+    /* ignored by tcp, but vital for ssl */
     char *(*socket_error) (Socket s);
 };
 
 struct plug_function_table {
     int (*closing)
-       (Plug p, char *error_msg, int error_code, int calling_back);
-       /* error_msg is NULL iff it is not an error (ie it closed normally) */
-       /* calling_back != 0 iff there is a Plug function */
-       /* currently running (would cure the fixme in try_send()) */
+     (Plug p, char *error_msg, int error_code, int calling_back);
+    /* error_msg is NULL iff it is not an error (ie it closed normally) */
+    /* calling_back != 0 iff there is a Plug function */
+    /* currently running (would cure the fixme in try_send()) */
     int (*receive) (Plug p, int urgent, char *data, int len);
-       /*
-        *  - urgent==0. `data' points to `len' bytes of perfectly
-        *    ordinary data.
-        * 
-        *  - urgent==1. `data' points to `len' bytes of data,
-        *    which were read from before an Urgent pointer.
-        * 
-        *  - urgent==2. `data' points to `len' bytes of data,
-        *    the first of which was the one at the Urgent mark.
-        */
+    /*
+     *  - urgent==0. `data' points to `len' bytes of perfectly
+     *    ordinary data.
+     * 
+     *  - urgent==1. `data' points to `len' bytes of data,
+     *    which were read from before an Urgent pointer.
+     * 
+     *  - urgent==2. `data' points to `len' bytes of data,
+     *    the first of which was the one at the Urgent mark.
+     */
+    int (*accepting)(Plug p, struct sockaddr *addr, void *sock);
+    /*
+     * returns 0 if the host at address addr is a valid host for connecting or error
+     */
 };
 
 
@@ -56,7 +60,12 @@ void sk_init(void);                 /* called once at program startup */
 SockAddr sk_namelookup(char *host, char **canonicalname);
 void sk_addr_free(SockAddr addr);
 
-Socket sk_new(SockAddr addr, int port, int privport, int oobinline, Plug p);
+Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
+             Plug p);
+
+Socket sk_newlistenner(int port, Plug plug);
+
+Socket sk_register(void *sock, Plug plug);
 
 #define sk_plug(s,p) (((*s)->plug) (s, p))
 #define sk_close(s) (((*s)->close) (s))
@@ -67,6 +76,7 @@ Socket sk_new(SockAddr addr, int port, int privport, int oobinline, Plug p);
 #ifdef DEFINE_PLUG_METHOD_MACROS
 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))
 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))
+#define plug_accepting(p, addr, sock) (((*p)->accepting)(p, addr, sock))
 #endif
 
 /*
@@ -87,6 +97,14 @@ void *sk_get_private_ptr(Socket s);
 char *sk_addr_error(SockAddr addr);
 #define sk_socket_error(s) (((*s)->socket_error) (s))
 
+/*
+ * Set the `frozen' flag on a socket. A frozen socket is one in
+ * which all sends are buffered and receives are ignored. This is
+ * so that (for example) a new port-forwarding can sit in limbo
+ * until its associated SSH channel is ready, and then pending data
+ * can be sent on.
+ */
+void sk_set_frozen(Socket sock, int is_frozen);
 
 /********** SSL stuff **********/
 
@@ -95,7 +113,6 @@ char *sk_addr_error(SockAddr addr);
  * of what it will eventually look like.
  */
 
-
 typedef struct certificate *Certificate;
 typedef struct our_certificate *Our_Certificate;
     /* to be defined somewhere else, somehow */
@@ -106,24 +123,22 @@ typedef struct ssl_client_plug_function_table **SSL_Client_Plug;
 struct ssl_client_socket_function_table {
     struct socket_function_table base;
     void (*renegotiate) (SSL_Client_Socket s);
-       /* renegotiate the cipher spec */
+    /* renegotiate the cipher spec */
 };
 
 struct ssl_client_plug_function_table {
     struct plug_function_table base;
     int (*refuse_cert) (SSL_Client_Plug p, Certificate cert[]);
-       /* do we accept this certificate chain?  If not, why not? */
-       /* cert[0] is the server's certificate, cert[] is NULL-terminated */
-       /* the last certificate may or may not be the root certificate */
-    Our_Certificate (*client_cert) (SSL_Client_Plug p);
-       /* the server wants us to identify ourselves */
-       /* may return NULL if we want anonymity */
+    /* do we accept this certificate chain?  If not, why not? */
+    /* cert[0] is the server's certificate, cert[] is NULL-terminated */
+    /* the last certificate may or may not be the root certificate */
+     Our_Certificate(*client_cert) (SSL_Client_Plug p);
+    /* the server wants us to identify ourselves */
+    /* may return NULL if we want anonymity */
 };
 
-SSL_Client_Socket sk_ssl_client_over (
-    Socket s, /* pre-existing (tcp) connection */
-    SSL_Client_Plug p
-);
+SSL_Client_Socket sk_ssl_client_over(Socket s, /* pre-existing (tcp) connection */
+                                    SSL_Client_Plug p);
 
 #define sk_renegotiate(s) (((*s)->renegotiate) (s))