2 * Networking abstraction in PuTTY.
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.
13 #ifndef PUTTY_NETWORK_H
14 #define PUTTY_NETWORK_H
18 typedef struct conf_tag Conf;
19 typedef struct backend_tag Backend;
20 typedef struct terminal_tag Terminal;
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;
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_private_ptr) (Socket s, void *ptr);
39 void *(*get_private_ptr) (Socket s);
40 void (*set_frozen) (Socket s, int is_frozen);
41 /* ignored by tcp, but vital for ssl */
42 const char *(*socket_error) (Socket s);
45 typedef union { void *p; int i; } accept_ctx_t;
46 typedef Socket (*accept_fn_t)(accept_ctx_t ctx, Plug plug);
48 struct plug_function_table {
49 void (*log)(Plug p, int type, SockAddr addr, int port,
50 const char *error_msg, int error_code);
52 * Passes the client progress reports on the process of setting
55 * - type==0 means we are about to try to connect to address
56 * `addr' (error_msg and error_code are ignored)
57 * - type==1 means we have failed to connect to address `addr'
58 * (error_msg and error_code are supplied). This is not a
59 * fatal error - we may well have other candidate addresses
60 * to fall back to. When it _is_ fatal, the closing()
61 * function will be called.
64 (Plug p, const char *error_msg, int error_code, int calling_back);
65 /* error_msg is NULL iff it is not an error (ie it closed normally) */
66 /* calling_back != 0 iff there is a Plug function */
67 /* currently running (would cure the fixme in try_send()) */
68 int (*receive) (Plug p, int urgent, char *data, int len);
70 * - urgent==0. `data' points to `len' bytes of perfectly
73 * - urgent==1. `data' points to `len' bytes of data,
74 * which were read from before an Urgent pointer.
76 * - urgent==2. `data' points to `len' bytes of data,
77 * the first of which was the one at the Urgent mark.
79 void (*sent) (Plug p, int bufsize);
81 * The `sent' function is called when the pending send backlog
82 * on a socket is cleared or partially cleared. The new backlog
83 * size is passed in the `bufsize' parameter.
85 int (*accepting)(Plug p, accept_fn_t constructor, accept_ctx_t ctx);
87 * `accepting' is called only on listener-type sockets, and is
88 * passed a constructor function+context that will create a fresh
89 * Socket describing the connection. It returns nonzero if it
90 * doesn't want the connection for some reason, or 0 on success.
94 /* proxy indirection layer */
95 /* NB, control of 'addr' is passed via new_connection, which takes
96 * responsibility for freeing it */
97 Socket new_connection(SockAddr addr, char *hostname,
98 int port, int privport,
99 int oobinline, int nodelay, int keepalive,
100 Plug plug, Conf *conf);
101 Socket new_listener(char *srcaddr, int port, Plug plug, int local_host_only,
102 Conf *conf, int addressfamily);
103 SockAddr name_lookup(char *host, int port, char **canonicalname,
104 Conf *conf, int addressfamily);
106 /* platform-dependent callback from new_connection() */
107 /* (same caveat about addr as new_connection()) */
108 Socket platform_new_connection(SockAddr addr, char *hostname,
109 int port, int privport,
110 int oobinline, int nodelay, int keepalive,
111 Plug plug, Conf *conf);
113 /* socket functions */
115 void sk_init(void); /* called once at program startup */
116 void sk_cleanup(void); /* called just before program exit */
118 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family);
119 SockAddr sk_nonamelookup(const char *host);
120 void sk_getaddr(SockAddr addr, char *buf, int buflen);
121 int sk_hostname_is_local(const char *name);
122 int sk_address_is_local(SockAddr addr);
123 int sk_address_is_special_local(SockAddr addr);
124 int sk_addrtype(SockAddr addr);
125 void sk_addrcopy(SockAddr addr, char *buf);
126 void sk_addr_free(SockAddr addr);
127 /* sk_addr_dup generates another SockAddr which contains the same data
128 * as the original one and can be freed independently. May not actually
129 * physically _duplicate_ it: incrementing a reference count so that
130 * one more free is required before it disappears is an acceptable
132 SockAddr sk_addr_dup(SockAddr addr);
134 /* NB, control of 'addr' is passed via sk_new, which takes responsibility
135 * for freeing it, as for new_connection() */
136 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
137 int nodelay, int keepalive, Plug p);
139 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int address_family);
141 #define sk_plug(s,p) (((*s)->plug) (s, p))
142 #define sk_close(s) (((*s)->close) (s))
143 #define sk_write(s,buf,len) (((*s)->write) (s, buf, len))
144 #define sk_write_oob(s,buf,len) (((*s)->write_oob) (s, buf, len))
145 #define sk_write_eof(s) (((*s)->write_eof) (s))
146 #define sk_flush(s) (((*s)->flush) (s))
148 #ifdef DEFINE_PLUG_METHOD_MACROS
149 #define plug_log(p,type,addr,port,msg,code) (((*p)->log) (p, type, addr, port, msg, code))
150 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))
151 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))
152 #define plug_sent(p,bufsize) (((*p)->sent) (p, bufsize))
153 #define plug_accepting(p, constructor, ctx) (((*p)->accepting)(p, constructor, ctx))
157 * Each socket abstraction contains a `void *' private field in
158 * which the client can keep state.
160 * This is perhaps unnecessary now that we have the notion of a plug,
161 * but there is some existing code that uses it, so it stays.
163 #define sk_set_private_ptr(s, ptr) (((*s)->set_private_ptr) (s, ptr))
164 #define sk_get_private_ptr(s) (((*s)->get_private_ptr) (s))
167 * Special error values are returned from sk_namelookup and sk_new
168 * if there's a problem. These functions extract an error message,
169 * or return NULL if there's no problem.
171 const char *sk_addr_error(SockAddr addr);
172 #define sk_socket_error(s) (((*s)->socket_error) (s))
175 * Set the `frozen' flag on a socket. A frozen socket is one in
176 * which all READABLE notifications are ignored, so that data is
177 * not accepted from the peer until the socket is unfrozen. This
178 * exists for two purposes:
180 * - Port forwarding: when a local listening port receives a
181 * connection, we do not want to receive data from the new
182 * socket until we have somewhere to send it. Hence, we freeze
183 * the socket until its associated SSH channel is ready; then we
184 * unfreeze it and pending data is delivered.
186 * - Socket buffering: if an SSH channel (or the whole connection)
187 * backs up or presents a zero window, we must freeze the
188 * associated local socket in order to avoid unbounded buffer
191 #define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen))
194 * Simple wrapper on getservbyname(), needed by ssh.c. Returns the
195 * port number, in host byte order (suitable for printf and so on).
196 * Returns 0 on failure. Any platform not supporting getservbyname
197 * can just return 0 - this function is not required to handle
198 * numeric port specifications.
200 int net_service_lookup(char *service);
203 * Look up the local hostname; return value needs freeing.
206 char *get_hostname(void);
209 * Trivial socket implementation which just stores an error. Found in
212 Socket new_error_socket(const char *errmsg, Plug plug);
214 /********** SSL stuff **********/
217 * This section is subject to change, but you get the general idea
218 * of what it will eventually look like.
221 typedef struct certificate *Certificate;
222 typedef struct our_certificate *Our_Certificate;
223 /* to be defined somewhere else, somehow */
225 typedef struct ssl_client_socket_function_table **SSL_Client_Socket;
226 typedef struct ssl_client_plug_function_table **SSL_Client_Plug;
228 struct ssl_client_socket_function_table {
229 struct socket_function_table base;
230 void (*renegotiate) (SSL_Client_Socket s);
231 /* renegotiate the cipher spec */
234 struct ssl_client_plug_function_table {
235 struct plug_function_table base;
236 int (*refuse_cert) (SSL_Client_Plug p, Certificate cert[]);
237 /* do we accept this certificate chain? If not, why not? */
238 /* cert[0] is the server's certificate, cert[] is NULL-terminated */
239 /* the last certificate may or may not be the root certificate */
240 Our_Certificate(*client_cert) (SSL_Client_Plug p);
241 /* the server wants us to identify ourselves */
242 /* may return NULL if we want anonymity */
245 SSL_Client_Socket sk_ssl_client_over(Socket s, /* pre-existing (tcp) connection */
248 #define sk_renegotiate(s) (((*s)->renegotiate) (s))