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 config_tag Config
;
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 #ifndef OSSOCKET_DEFINED
29 typedef void *OSSocket
;
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
);
48 struct plug_function_table
{
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
);
56 * - urgent==0. `data' points to `len' bytes of perfectly
59 * - urgent==1. `data' points to `len' bytes of data,
60 * which were read from before an Urgent pointer.
62 * - urgent==2. `data' points to `len' bytes of data,
63 * the first of which was the one at the Urgent mark.
65 void (*sent
) (Plug p
, int bufsize
);
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.
71 int (*accepting
)(Plug p
, OSSocket sock
);
73 * returns 0 if the host at address addr is a valid host for connecting or error
77 /* proxy indirection layer */
78 Socket
new_connection(SockAddr addr
, char *hostname
,
79 int port
, int privport
,
80 int oobinline
, int nodelay
, Plug plug
,
82 Socket
new_listener(char *srcaddr
, int port
, Plug plug
, int local_host_only
,
84 SockAddr
name_lookup(char *host
, int port
, char **canonicalname
,
87 /* platform-dependent callback from new_connection() */
88 Socket
platform_new_connection(SockAddr addr
, char *hostname
,
89 int port
, int privport
,
90 int oobinline
, int nodelay
, Plug plug
,
93 /* socket functions */
95 void sk_init(void); /* called once at program startup */
96 void sk_cleanup(void); /* called just before program exit */
98 SockAddr
sk_namelookup(const char *host
, char **canonicalname
);
99 SockAddr
sk_nonamelookup(const char *host
);
100 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
);
101 int sk_hostname_is_local(char *name
);
102 int sk_address_is_local(SockAddr addr
);
103 enum { ADDRTYPE_IPV4
, ADDRTYPE_IPV6
, ADDRTYPE_NAME
};
104 int sk_addrtype(SockAddr addr
);
105 void sk_addrcopy(SockAddr addr
, char *buf
);
106 void sk_addr_free(SockAddr addr
);
108 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
109 int nodelay
, Plug p
);
111 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
);
113 Socket
sk_register(OSSocket sock
, Plug plug
);
115 #define sk_plug(s,p) (((*s)->plug) (s, p))
116 #define sk_close(s) (((*s)->close) (s))
117 #define sk_write(s,buf,len) (((*s)->write) (s, buf, len))
118 #define sk_write_oob(s,buf,len) (((*s)->write_oob) (s, buf, len))
119 #define sk_flush(s) (((*s)->flush) (s))
121 #ifdef DEFINE_PLUG_METHOD_MACROS
122 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))
123 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))
124 #define plug_sent(p,bufsize) (((*p)->sent) (p, bufsize))
125 #define plug_accepting(p, sock) (((*p)->accepting)(p, sock))
129 * Each socket abstraction contains a `void *' private field in
130 * which the client can keep state.
132 * This is perhaps unnecessary now that we have the notion of a plug,
133 * but there is some existing code that uses it, so it stays.
135 #define sk_set_private_ptr(s, ptr) (((*s)->set_private_ptr) (s, ptr))
136 #define sk_get_private_ptr(s) (((*s)->get_private_ptr) (s))
139 * Special error values are returned from sk_namelookup and sk_new
140 * if there's a problem. These functions extract an error message,
141 * or return NULL if there's no problem.
143 const char *sk_addr_error(SockAddr addr
);
144 #define sk_socket_error(s) (((*s)->socket_error) (s))
147 * Set the `frozen' flag on a socket. A frozen socket is one in
148 * which all READABLE notifications are ignored, so that data is
149 * not accepted from the peer until the socket is unfrozen. This
150 * exists for two purposes:
152 * - Port forwarding: when a local listening port receives a
153 * connection, we do not want to receive data from the new
154 * socket until we have somewhere to send it. Hence, we freeze
155 * the socket until its associated SSH channel is ready; then we
156 * unfreeze it and pending data is delivered.
158 * - Socket buffering: if an SSH channel (or the whole connection)
159 * backs up or presents a zero window, we must freeze the
160 * associated local socket in order to avoid unbounded buffer
163 #define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen))
166 * Call this after an operation that might have tried to send on a
167 * socket, to clean up any pending network errors.
169 void net_pending_errors(void);
172 * Simple wrapper on getservbyname(), needed by ssh.c. Returns the
173 * port number, in host byte order (suitable for printf and so on).
174 * Returns 0 on failure. Any platform not supporting getservbyname
175 * can just return 0 - this function is not required to handle
176 * numeric port specifications.
178 int net_service_lookup(char *service
);
180 /********** SSL stuff **********/
183 * This section is subject to change, but you get the general idea
184 * of what it will eventually look like.
187 typedef struct certificate
*Certificate
;
188 typedef struct our_certificate
*Our_Certificate
;
189 /* to be defined somewhere else, somehow */
191 typedef struct ssl_client_socket_function_table
**SSL_Client_Socket
;
192 typedef struct ssl_client_plug_function_table
**SSL_Client_Plug
;
194 struct ssl_client_socket_function_table
{
195 struct socket_function_table base
;
196 void (*renegotiate
) (SSL_Client_Socket s
);
197 /* renegotiate the cipher spec */
200 struct ssl_client_plug_function_table
{
201 struct plug_function_table base
;
202 int (*refuse_cert
) (SSL_Client_Plug p
, Certificate cert
[]);
203 /* do we accept this certificate chain? If not, why not? */
204 /* cert[0] is the server's certificate, cert[] is NULL-terminated */
205 /* the last certificate may or may not be the root certificate */
206 Our_Certificate(*client_cert
) (SSL_Client_Plug p
);
207 /* the server wants us to identify ourselves */
208 /* may return NULL if we want anonymity */
211 SSL_Client_Socket
sk_ssl_client_over(Socket s
, /* pre-existing (tcp) connection */
214 #define sk_renegotiate(s) (((*s)->renegotiate) (s))