OSDN Git Service

Add support for MLSD responses from some broken hosts.
[ffftp/ffftp.git] / putty / NETWORK.H
1 /*\r
2  * Networking abstraction in PuTTY.\r
3  *\r
4  * The way this works is: a back end can choose to open any number\r
5  * of sockets - including zero, which might be necessary in some.\r
6  * It can register a bunch of callbacks (most notably for when \r
7  * data is received) for each socket, and it can call the networking\r
8  * abstraction to send data without having to worry about blocking.\r
9  * The stuff behind the abstraction takes care of selects and\r
10  * nonblocking writes and all that sort of painful gubbins.\r
11  */\r
12 \r
13 #ifndef PUTTY_NETWORK_H\r
14 #define PUTTY_NETWORK_H\r
15 \r
16 #ifndef DONE_TYPEDEFS\r
17 #define DONE_TYPEDEFS\r
18 typedef struct config_tag Config;\r
19 typedef struct backend_tag Backend;\r
20 typedef struct terminal_tag Terminal;\r
21 #endif\r
22 \r
23 typedef struct SockAddr_tag *SockAddr;\r
24 /* pay attention to levels of indirection */\r
25 typedef struct socket_function_table **Socket;\r
26 typedef struct plug_function_table **Plug;\r
27 \r
28 #ifndef OSSOCKET_DEFINED\r
29 typedef void *OSSocket;\r
30 #endif\r
31 \r
32 struct socket_function_table {\r
33     Plug(*plug) (Socket s, Plug p);\r
34     /* use a different plug (return the old one) */\r
35     /* if p is NULL, it doesn't change the plug */\r
36     /* but it does return the one it's using */\r
37     void (*close) (Socket s);\r
38     int (*write) (Socket s, const char *data, int len);\r
39     int (*write_oob) (Socket s, const char *data, int len);\r
40     void (*flush) (Socket s);\r
41     void (*set_private_ptr) (Socket s, void *ptr);\r
42     void *(*get_private_ptr) (Socket s);\r
43     void (*set_frozen) (Socket s, int is_frozen);\r
44     /* ignored by tcp, but vital for ssl */\r
45     const char *(*socket_error) (Socket s);\r
46 };\r
47 \r
48 struct plug_function_table {\r
49     void (*log)(Plug p, int type, SockAddr addr, int port,\r
50                 const char *error_msg, int error_code);\r
51     /*\r
52      * Passes the client progress reports on the process of setting\r
53      * up the connection.\r
54      * \r
55      *  - type==0 means we are about to try to connect to address\r
56      *    `addr' (error_msg and error_code are ignored)\r
57      *  - type==1 means we have failed to connect to address `addr'\r
58      *    (error_msg and error_code are supplied). This is not a\r
59      *    fatal error - we may well have other candidate addresses\r
60      *    to fall back to. When it _is_ fatal, the closing()\r
61      *    function will be called.\r
62      */\r
63     int (*closing)\r
64      (Plug p, const char *error_msg, int error_code, int calling_back);\r
65     /* error_msg is NULL iff it is not an error (ie it closed normally) */\r
66     /* calling_back != 0 iff there is a Plug function */\r
67     /* currently running (would cure the fixme in try_send()) */\r
68     int (*receive) (Plug p, int urgent, char *data, int len);\r
69     /*\r
70      *  - urgent==0. `data' points to `len' bytes of perfectly\r
71      *    ordinary data.\r
72      * \r
73      *  - urgent==1. `data' points to `len' bytes of data,\r
74      *    which were read from before an Urgent pointer.\r
75      * \r
76      *  - urgent==2. `data' points to `len' bytes of data,\r
77      *    the first of which was the one at the Urgent mark.\r
78      */\r
79     void (*sent) (Plug p, int bufsize);\r
80     /*\r
81      * The `sent' function is called when the pending send backlog\r
82      * on a socket is cleared or partially cleared. The new backlog\r
83      * size is passed in the `bufsize' parameter.\r
84      */\r
85     int (*accepting)(Plug p, OSSocket sock);\r
86     /*\r
87      * returns 0 if the host at address addr is a valid host for connecting or error\r
88      */\r
89 };\r
90 \r
91 /* proxy indirection layer */\r
92 /* NB, control of 'addr' is passed via new_connection, which takes\r
93  * responsibility for freeing it */\r
94 Socket new_connection(SockAddr addr, char *hostname,\r
95                       int port, int privport,\r
96                       int oobinline, int nodelay, int keepalive,\r
97                       Plug plug, const Config *cfg);\r
98 Socket new_listener(char *srcaddr, int port, Plug plug, int local_host_only,\r
99                     const Config *cfg, int addressfamily);\r
100 SockAddr name_lookup(char *host, int port, char **canonicalname,\r
101                      const Config *cfg, int addressfamily);\r
102 \r
103 /* platform-dependent callback from new_connection() */\r
104 /* (same caveat about addr as new_connection()) */\r
105 Socket platform_new_connection(SockAddr addr, char *hostname,\r
106                                int port, int privport,\r
107                                int oobinline, int nodelay, int keepalive,\r
108                                Plug plug, const Config *cfg);\r
109 \r
110 /* socket functions */\r
111 \r
112 void sk_init(void);                    /* called once at program startup */\r
113 void sk_cleanup(void);                 /* called just before program exit */\r
114 \r
115 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family);\r
116 SockAddr sk_nonamelookup(const char *host);\r
117 void sk_getaddr(SockAddr addr, char *buf, int buflen);\r
118 int sk_hostname_is_local(char *name);\r
119 int sk_address_is_local(SockAddr addr);\r
120 int sk_addrtype(SockAddr addr);\r
121 void sk_addrcopy(SockAddr addr, char *buf);\r
122 void sk_addr_free(SockAddr addr);\r
123 /* sk_addr_dup generates another SockAddr which contains the same data\r
124  * as the original one and can be freed independently. May not actually\r
125  * physically _duplicate_ it: incrementing a reference count so that\r
126  * one more free is required before it disappears is an acceptable\r
127  * implementation. */\r
128 SockAddr sk_addr_dup(SockAddr addr);\r
129 \r
130 /* NB, control of 'addr' is passed via sk_new, which takes responsibility\r
131  * for freeing it, as for new_connection() */\r
132 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,\r
133               int nodelay, int keepalive, Plug p);\r
134 \r
135 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int address_family);\r
136 \r
137 Socket sk_register(OSSocket sock, Plug plug);\r
138 \r
139 #define sk_plug(s,p) (((*s)->plug) (s, p))\r
140 #define sk_close(s) (((*s)->close) (s))\r
141 #define sk_write(s,buf,len) (((*s)->write) (s, buf, len))\r
142 #define sk_write_oob(s,buf,len) (((*s)->write_oob) (s, buf, len))\r
143 #define sk_flush(s) (((*s)->flush) (s))\r
144 \r
145 #ifdef DEFINE_PLUG_METHOD_MACROS\r
146 #define plug_log(p,type,addr,port,msg,code) (((*p)->log) (p, type, addr, port, msg, code))\r
147 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))\r
148 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))\r
149 #define plug_sent(p,bufsize) (((*p)->sent) (p, bufsize))\r
150 #define plug_accepting(p, sock) (((*p)->accepting)(p, sock))\r
151 #endif\r
152 \r
153 /*\r
154  * Each socket abstraction contains a `void *' private field in\r
155  * which the client can keep state.\r
156  *\r
157  * This is perhaps unnecessary now that we have the notion of a plug,\r
158  * but there is some existing code that uses it, so it stays.\r
159  */\r
160 #define sk_set_private_ptr(s, ptr) (((*s)->set_private_ptr) (s, ptr))\r
161 #define sk_get_private_ptr(s) (((*s)->get_private_ptr) (s))\r
162 \r
163 /*\r
164  * Special error values are returned from sk_namelookup and sk_new\r
165  * if there's a problem. These functions extract an error message,\r
166  * or return NULL if there's no problem.\r
167  */\r
168 const char *sk_addr_error(SockAddr addr);\r
169 #define sk_socket_error(s) (((*s)->socket_error) (s))\r
170 \r
171 /*\r
172  * Set the `frozen' flag on a socket. A frozen socket is one in\r
173  * which all READABLE notifications are ignored, so that data is\r
174  * not accepted from the peer until the socket is unfrozen. This\r
175  * exists for two purposes:\r
176  * \r
177  *  - Port forwarding: when a local listening port receives a\r
178  *    connection, we do not want to receive data from the new\r
179  *    socket until we have somewhere to send it. Hence, we freeze\r
180  *    the socket until its associated SSH channel is ready; then we\r
181  *    unfreeze it and pending data is delivered.\r
182  * \r
183  *  - Socket buffering: if an SSH channel (or the whole connection)\r
184  *    backs up or presents a zero window, we must freeze the\r
185  *    associated local socket in order to avoid unbounded buffer\r
186  *    growth.\r
187  */\r
188 #define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen))\r
189 \r
190 /*\r
191  * Call this after an operation that might have tried to send on a\r
192  * socket, to clean up any pending network errors.\r
193  */\r
194 void net_pending_errors(void);\r
195 \r
196 /*\r
197  * Simple wrapper on getservbyname(), needed by ssh.c. Returns the\r
198  * port number, in host byte order (suitable for printf and so on).\r
199  * Returns 0 on failure. Any platform not supporting getservbyname\r
200  * can just return 0 - this function is not required to handle\r
201  * numeric port specifications.\r
202  */\r
203 int net_service_lookup(char *service);\r
204 \r
205 /*\r
206  * Look up the local hostname; return value needs freeing.\r
207  * May return NULL.\r
208  */\r
209 char *get_hostname(void);\r
210 \r
211 /********** SSL stuff **********/\r
212 \r
213 /*\r
214  * This section is subject to change, but you get the general idea\r
215  * of what it will eventually look like.\r
216  */\r
217 \r
218 typedef struct certificate *Certificate;\r
219 typedef struct our_certificate *Our_Certificate;\r
220     /* to be defined somewhere else, somehow */\r
221 \r
222 typedef struct ssl_client_socket_function_table **SSL_Client_Socket;\r
223 typedef struct ssl_client_plug_function_table **SSL_Client_Plug;\r
224 \r
225 struct ssl_client_socket_function_table {\r
226     struct socket_function_table base;\r
227     void (*renegotiate) (SSL_Client_Socket s);\r
228     /* renegotiate the cipher spec */\r
229 };\r
230 \r
231 struct ssl_client_plug_function_table {\r
232     struct plug_function_table base;\r
233     int (*refuse_cert) (SSL_Client_Plug p, Certificate cert[]);\r
234     /* do we accept this certificate chain?  If not, why not? */\r
235     /* cert[0] is the server's certificate, cert[] is NULL-terminated */\r
236     /* the last certificate may or may not be the root certificate */\r
237      Our_Certificate(*client_cert) (SSL_Client_Plug p);\r
238     /* the server wants us to identify ourselves */\r
239     /* may return NULL if we want anonymity */\r
240 };\r
241 \r
242 SSL_Client_Socket sk_ssl_client_over(Socket s,  /* pre-existing (tcp) connection */\r
243                                      SSL_Client_Plug p);\r
244 \r
245 #define sk_renegotiate(s) (((*s)->renegotiate) (s))\r
246 \r
247 #endif\r