src/TortoisePlink/PROXY.H

   1 /*\r
   2  * Network proxy abstraction in PuTTY\r
   3  *\r
   4  * A proxy layer, if necessary, wedges itself between the\r
   5  * network code and the higher level backend.\r
   6  *\r
   7  * Supported proxies: HTTP CONNECT, generic telnet, SOCKS 4 & 5\r
   8  */\r
   9 \r
  10 #ifndef PUTTY_PROXY_H\r
  11 #define PUTTY_PROXY_H\r
  12 \r
  13 #define PROXY_ERROR_GENERAL 8000\r
  14 #define PROXY_ERROR_UNEXPECTED 8001\r
  15 \r
  16 typedef struct Socket_proxy_tag * Proxy_Socket;\r
  17 \r
  18 struct Socket_proxy_tag {\r
  19     const struct socket_function_table *fn;\r
  20     /* the above variable absolutely *must* be the first in this structure */\r
  21 \r
  22     char * error;\r
  23 \r
  24     Socket sub_socket;\r
  25     Plug plug;\r
  26     SockAddr remote_addr;\r
  27     int remote_port;\r
  28 \r
  29     bufchain pending_output_data;\r
  30     bufchain pending_oob_output_data;\r
  31     int pending_flush;\r
  32     bufchain pending_input_data;\r
  33     int pending_eof;\r
  34 \r
  35 #define PROXY_STATE_NEW    -1\r
  36 #define PROXY_STATE_ACTIVE  0\r
  37 \r
  38     int state; /* proxy states greater than 0 are implementation\r
  39                 * dependent, but represent various stages/states\r
  40                 * of the initialization/setup/negotiation with the\r
  41                 * proxy server.\r
  42                 */\r
  43     int freeze; /* should we freeze the underlying socket when\r
  44                  * we are done with the proxy negotiation? this\r
  45                  * simply caches the value of sk_set_frozen calls.\r
  46                  */\r
  47 \r
  48 #define PROXY_CHANGE_NEW      -1\r
  49 #define PROXY_CHANGE_CLOSING   0\r
  50 #define PROXY_CHANGE_SENT      1\r
  51 #define PROXY_CHANGE_RECEIVE   2\r
  52 #define PROXY_CHANGE_ACCEPTING 3\r
  53 \r
  54     /* something has changed (a call from the sub socket\r
  55      * layer into our Proxy Plug layer, or we were just\r
  56      * created, etc), so the proxy layer needs to handle\r
  57      * this change (the type of which is the second argument)\r
  58      * and further the proxy negotiation process.\r
  59      */\r
  60 \r
  61     int (*negotiate) (Proxy_Socket /* this */, int /* change type */);\r
  62 \r
  63     /* current arguments of plug handlers\r
  64      * (for use by proxy's negotiate function)\r
  65      */\r
  66 \r
  67     /* closing */\r
  68     const char *closing_error_msg;\r
  69     int closing_error_code;\r
  70     int closing_calling_back;\r
  71 \r
  72     /* receive */\r
  73     int receive_urgent;\r
  74     char *receive_data;\r
  75     int receive_len;\r
  76 \r
  77     /* sent */\r
  78     int sent_bufsize;\r
  79 \r
  80     /* accepting */\r
  81     OSSocket accepting_sock;\r
  82 \r
  83     /* configuration, used to look up proxy settings */\r
  84     Conf *conf;\r
  85 \r
  86     /* CHAP transient data */\r
  87     int chap_num_attributes;\r
  88     int chap_num_attributes_processed;\r
  89     int chap_current_attribute;\r
  90     int chap_current_datalen;\r
  91 };\r
  92 \r
  93 typedef struct Plug_proxy_tag * Proxy_Plug;\r
  94 \r
  95 struct Plug_proxy_tag {\r
  96     const struct plug_function_table *fn;\r
  97     /* the above variable absolutely *must* be the first in this structure */\r
  98 \r
  99     Proxy_Socket proxy_socket;\r
 100 \r
 101 };\r
 102 \r
 103 extern void proxy_activate (Proxy_Socket);\r
 104 \r
 105 extern int proxy_http_negotiate (Proxy_Socket, int);\r
 106 extern int proxy_telnet_negotiate (Proxy_Socket, int);\r
 107 extern int proxy_socks4_negotiate (Proxy_Socket, int);\r
 108 extern int proxy_socks5_negotiate (Proxy_Socket, int);\r
 109 \r
 110 /*\r
 111  * This may be reused by local-command proxies on individual\r
 112  * platforms.\r
 113  */\r
 114 char *format_telnet_command(SockAddr addr, int port, Conf *conf);\r
 115 \r
 116 /*\r
 117  * These are implemented in cproxy.c or nocproxy.c, depending on\r
 118  * whether encrypted proxy authentication is available.\r
 119  */\r
 120 extern void proxy_socks5_offerencryptedauth(char *command, int *len);\r
 121 extern int proxy_socks5_handlechap (Proxy_Socket p);\r
 122 extern int proxy_socks5_selectchap(Proxy_Socket p);\r
 123 \r
 124 #endif\r