X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=network.h;h=ec67ba942345f9b15d5f3813c856942bd6f80667;hb=89da2ddf564a93414ee9ab2df3f053608094e417;hp=28744a6f5f5369b7d9b84ea315a45e1d090bcb29;hpb=f2319456bc1e36ff84bf250d8f0ccd5b39c96269;p=PuTTY.git diff --git a/network.h b/network.h index 28744a6f..ec67ba94 100644 --- a/network.h +++ b/network.h @@ -13,6 +13,13 @@ #ifndef PUTTY_NETWORK_H #define PUTTY_NETWORK_H +#ifndef DONE_TYPEDEFS +#define DONE_TYPEDEFS +typedef struct conf_tag Conf; +typedef struct backend_tag Backend; +typedef struct terminal_tag Terminal; +#endif + typedef struct SockAddr_tag *SockAddr; /* pay attention to levels of indirection */ typedef struct socket_function_table **Socket; @@ -24,16 +31,35 @@ struct socket_function_table { /* if p is NULL, it doesn't change the plug */ /* but it does return the one it's using */ void (*close) (Socket s); - int (*write) (Socket s, char *data, int len); - int (*write_oob) (Socket s, char *data, int len); + int (*write) (Socket s, const char *data, int len); + int (*write_oob) (Socket s, const char *data, int len); + void (*write_eof) (Socket s); void (*flush) (Socket s); + void (*set_frozen) (Socket s, int is_frozen); /* ignored by tcp, but vital for ssl */ - char *(*socket_error) (Socket s); + const char *(*socket_error) (Socket s); }; +typedef union { void *p; int i; } accept_ctx_t; +typedef Socket (*accept_fn_t)(accept_ctx_t ctx, Plug plug); + struct plug_function_table { + void (*log)(Plug p, int type, SockAddr addr, int port, + const char *error_msg, int error_code); + /* + * Passes the client progress reports on the process of setting + * up the connection. + * + * - type==0 means we are about to try to connect to address + * `addr' (error_msg and error_code are ignored) + * - type==1 means we have failed to connect to address `addr' + * (error_msg and error_code are supplied). This is not a + * fatal error - we may well have other candidate addresses + * to fall back to. When it _is_ fatal, the closing() + * function will be called. + */ int (*closing) - (Plug p, char *error_msg, int error_code, int calling_back); + (Plug p, const 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()) */ @@ -54,55 +80,87 @@ struct plug_function_table { * on a socket is cleared or partially cleared. The new backlog * size is passed in the `bufsize' parameter. */ - int (*accepting)(Plug p, void *sock); + int (*accepting)(Plug p, accept_fn_t constructor, accept_ctx_t ctx); /* - * returns 0 if the host at address addr is a valid host for connecting or error + * `accepting' is called only on listener-type sockets, and is + * passed a constructor function+context that will create a fresh + * Socket describing the connection. It returns nonzero if it + * doesn't want the connection for some reason, or 0 on success. */ }; +/* proxy indirection layer */ +/* NB, control of 'addr' is passed via new_connection, which takes + * responsibility for freeing it */ +Socket new_connection(SockAddr addr, const char *hostname, + int port, int privport, + int oobinline, int nodelay, int keepalive, + Plug plug, Conf *conf); +Socket new_listener(const char *srcaddr, int port, Plug plug, + int local_host_only, Conf *conf, int addressfamily); +SockAddr name_lookup(const char *host, int port, char **canonicalname, + Conf *conf, int addressfamily); +int proxy_for_destination (SockAddr addr, const char *hostname, int port, + Conf *conf); + +/* platform-dependent callback from new_connection() */ +/* (same caveat about addr as new_connection()) */ +Socket platform_new_connection(SockAddr addr, const char *hostname, + int port, int privport, + int oobinline, int nodelay, int keepalive, + Plug plug, Conf *conf); + +/* socket functions */ void sk_init(void); /* called once at program startup */ +void sk_cleanup(void); /* called just before program exit */ -SockAddr sk_namelookup(char *host, char **canonicalname); +SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family); +SockAddr sk_nonamelookup(const char *host); void sk_getaddr(SockAddr addr, char *buf, int buflen); +int sk_addr_needs_port(SockAddr addr); +int sk_hostname_is_local(const char *name); +int sk_address_is_local(SockAddr addr); +int sk_address_is_special_local(SockAddr addr); +int sk_addrtype(SockAddr addr); +void sk_addrcopy(SockAddr addr, char *buf); void sk_addr_free(SockAddr addr); - +/* sk_addr_dup generates another SockAddr which contains the same data + * as the original one and can be freed independently. May not actually + * physically _duplicate_ it: incrementing a reference count so that + * one more free is required before it disappears is an acceptable + * implementation. */ +SockAddr sk_addr_dup(SockAddr addr); + +/* NB, control of 'addr' is passed via sk_new, which takes responsibility + * for freeing it, as for new_connection() */ Socket sk_new(SockAddr addr, int port, int privport, int oobinline, - Plug p); + int nodelay, int keepalive, Plug p); -Socket sk_newlistener(int port, Plug plug, int local_host_only); - -Socket sk_register(void *sock, Plug plug); +Socket sk_newlistener(const char *srcaddr, int port, Plug plug, + int local_host_only, int address_family); #define sk_plug(s,p) (((*s)->plug) (s, p)) #define sk_close(s) (((*s)->close) (s)) #define sk_write(s,buf,len) (((*s)->write) (s, buf, len)) #define sk_write_oob(s,buf,len) (((*s)->write_oob) (s, buf, len)) +#define sk_write_eof(s) (((*s)->write_eof) (s)) #define sk_flush(s) (((*s)->flush) (s)) #ifdef DEFINE_PLUG_METHOD_MACROS +#define plug_log(p,type,addr,port,msg,code) (((*p)->log) (p, type, addr, port, msg, code)) #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_sent(p,bufsize) (((*p)->sent) (p, bufsize)) -#define plug_accepting(p, sock) (((*p)->accepting)(p, sock)) +#define plug_accepting(p, constructor, ctx) (((*p)->accepting)(p, constructor, ctx)) #endif -/* - * Each socket abstraction contains a `void *' private field in - * which the client can keep state. - * - * This is perhaps unnecessary now that we have the notion of a plug, - * but there is some existing code that uses it, so it stays. - */ -void sk_set_private_ptr(Socket s, void *ptr); -void *sk_get_private_ptr(Socket s); - /* * Special error values are returned from sk_namelookup and sk_new * if there's a problem. These functions extract an error message, * or return NULL if there's no problem. */ -char *sk_addr_error(SockAddr addr); +const char *sk_addr_error(SockAddr addr); #define sk_socket_error(s) (((*s)->socket_error) (s)) /* @@ -122,13 +180,28 @@ char *sk_addr_error(SockAddr addr); * associated local socket in order to avoid unbounded buffer * growth. */ -void sk_set_frozen(Socket sock, int is_frozen); +#define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen)) + +/* + * Simple wrapper on getservbyname(), needed by ssh.c. Returns the + * port number, in host byte order (suitable for printf and so on). + * Returns 0 on failure. Any platform not supporting getservbyname + * can just return 0 - this function is not required to handle + * numeric port specifications. + */ +int net_service_lookup(char *service); + +/* + * Look up the local hostname; return value needs freeing. + * May return NULL. + */ +char *get_hostname(void); /* - * Call this after an operation that might have tried to send on a - * socket, to clean up any pending network errors. + * Trivial socket implementation which just stores an error. Found in + * errsock.c. */ -void net_pending_errors(void); +Socket new_error_socket(const char *errmsg, Plug plug); /********** SSL stuff **********/