2 * Network proxy abstraction in PuTTY
4 * A proxy layer, if necessary, wedges itself between the network
5 * code and the higher level backend.
12 #define DEFINE_PLUG_METHOD_MACROS
17 #define do_proxy_dns(cfg) \
18 (cfg->proxy_dns == FORCE_ON || \
19 (cfg->proxy_dns == AUTO && \
20 cfg->proxy_type != PROXY_SOCKS4 && \
21 cfg->proxy_type != PROXY_SOCKS5))
24 * Call this when proxy negotiation is complete, so that this
25 * socket can begin working normally.
27 void proxy_activate (Proxy_Socket p
)
31 long output_before
, output_after
;
33 p
->state
= PROXY_STATE_ACTIVE
;
35 /* we want to ignore new receive events until we have sent
36 * all of our buffered receive data.
38 sk_set_frozen(p
->sub_socket
, 1);
40 /* how many bytes of output have we buffered? */
41 output_before
= bufchain_size(&p
->pending_oob_output_data
) +
42 bufchain_size(&p
->pending_output_data
);
43 /* and keep track of how many bytes do not get sent. */
46 /* send buffered OOB writes */
47 while (bufchain_size(&p
->pending_oob_output_data
) > 0) {
48 bufchain_prefix(&p
->pending_oob_output_data
, &data
, &len
);
49 output_after
+= sk_write_oob(p
->sub_socket
, data
, len
);
50 bufchain_consume(&p
->pending_oob_output_data
, len
);
53 /* send buffered normal writes */
54 while (bufchain_size(&p
->pending_output_data
) > 0) {
55 bufchain_prefix(&p
->pending_output_data
, &data
, &len
);
56 output_after
+= sk_write(p
->sub_socket
, data
, len
);
57 bufchain_consume(&p
->pending_output_data
, len
);
60 /* if we managed to send any data, let the higher levels know. */
61 if (output_after
< output_before
)
62 plug_sent(p
->plug
, output_after
);
64 /* if we were asked to flush the output during
65 * the proxy negotiation process, do so now.
67 if (p
->pending_flush
) sk_flush(p
->sub_socket
);
69 /* if the backend wanted the socket unfrozen, try to unfreeze.
70 * our set_frozen handler will flush buffered receive data before
71 * unfreezing the actual underlying socket.
74 sk_set_frozen((Socket
)p
, 0);
77 /* basic proxy socket functions */
79 static Plug
sk_proxy_plug (Socket s
, Plug p
)
81 Proxy_Socket ps
= (Proxy_Socket
) s
;
88 static void sk_proxy_close (Socket s
)
90 Proxy_Socket ps
= (Proxy_Socket
) s
;
92 sk_close(ps
->sub_socket
);
93 sk_addr_free(ps
->remote_addr
);
97 static int sk_proxy_write (Socket s
, const char *data
, int len
)
99 Proxy_Socket ps
= (Proxy_Socket
) s
;
101 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
102 bufchain_add(&ps
->pending_output_data
, data
, len
);
103 return bufchain_size(&ps
->pending_output_data
);
105 return sk_write(ps
->sub_socket
, data
, len
);
108 static int sk_proxy_write_oob (Socket s
, const char *data
, int len
)
110 Proxy_Socket ps
= (Proxy_Socket
) s
;
112 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
113 bufchain_clear(&ps
->pending_output_data
);
114 bufchain_clear(&ps
->pending_oob_output_data
);
115 bufchain_add(&ps
->pending_oob_output_data
, data
, len
);
118 return sk_write_oob(ps
->sub_socket
, data
, len
);
121 static void sk_proxy_flush (Socket s
)
123 Proxy_Socket ps
= (Proxy_Socket
) s
;
125 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
126 ps
->pending_flush
= 1;
129 sk_flush(ps
->sub_socket
);
132 static void sk_proxy_set_private_ptr (Socket s
, void *ptr
)
134 Proxy_Socket ps
= (Proxy_Socket
) s
;
135 sk_set_private_ptr(ps
->sub_socket
, ptr
);
138 static void * sk_proxy_get_private_ptr (Socket s
)
140 Proxy_Socket ps
= (Proxy_Socket
) s
;
141 return sk_get_private_ptr(ps
->sub_socket
);
144 static void sk_proxy_set_frozen (Socket s
, int is_frozen
)
146 Proxy_Socket ps
= (Proxy_Socket
) s
;
148 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
149 ps
->freeze
= is_frozen
;
153 /* handle any remaining buffered recv data first */
154 if (bufchain_size(&ps
->pending_input_data
) > 0) {
155 ps
->freeze
= is_frozen
;
157 /* loop while we still have buffered data, and while we are
158 * unfrozen. the plug_receive call in the loop could result
159 * in a call back into this function refreezing the socket,
160 * so we have to check each time.
162 while (!ps
->freeze
&& bufchain_size(&ps
->pending_input_data
) > 0) {
166 bufchain_prefix(&ps
->pending_input_data
, &data
, &len
);
167 if (len
> lenof(databuf
))
168 len
= lenof(databuf
);
169 memcpy(databuf
, data
, len
);
170 bufchain_consume(&ps
->pending_input_data
, len
);
171 plug_receive(ps
->plug
, 0, databuf
, len
);
174 /* if we're still frozen, we'll have to wait for another
175 * call from the backend to finish unbuffering the data.
177 if (ps
->freeze
) return;
180 sk_set_frozen(ps
->sub_socket
, is_frozen
);
183 static const char * sk_proxy_socket_error (Socket s
)
185 Proxy_Socket ps
= (Proxy_Socket
) s
;
186 if (ps
->error
!= NULL
|| ps
->sub_socket
== NULL
) {
189 return sk_socket_error(ps
->sub_socket
);
192 /* basic proxy plug functions */
194 static int plug_proxy_closing (Plug p
, const char *error_msg
,
195 int error_code
, int calling_back
)
197 Proxy_Plug pp
= (Proxy_Plug
) p
;
198 Proxy_Socket ps
= pp
->proxy_socket
;
200 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
201 ps
->closing_error_msg
= error_msg
;
202 ps
->closing_error_code
= error_code
;
203 ps
->closing_calling_back
= calling_back
;
204 return ps
->negotiate(ps
, PROXY_CHANGE_CLOSING
);
206 return plug_closing(ps
->plug
, error_msg
,
207 error_code
, calling_back
);
210 static int plug_proxy_receive (Plug p
, int urgent
, char *data
, int len
)
212 Proxy_Plug pp
= (Proxy_Plug
) p
;
213 Proxy_Socket ps
= pp
->proxy_socket
;
215 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
216 /* we will lose the urgentness of this data, but since most,
217 * if not all, of this data will be consumed by the negotiation
218 * process, hopefully it won't affect the protocol above us
220 bufchain_add(&ps
->pending_input_data
, data
, len
);
221 ps
->receive_urgent
= urgent
;
222 ps
->receive_data
= data
;
223 ps
->receive_len
= len
;
224 return ps
->negotiate(ps
, PROXY_CHANGE_RECEIVE
);
226 return plug_receive(ps
->plug
, urgent
, data
, len
);
229 static void plug_proxy_sent (Plug p
, int bufsize
)
231 Proxy_Plug pp
= (Proxy_Plug
) p
;
232 Proxy_Socket ps
= pp
->proxy_socket
;
234 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
235 ps
->sent_bufsize
= bufsize
;
236 ps
->negotiate(ps
, PROXY_CHANGE_SENT
);
239 plug_sent(ps
->plug
, bufsize
);
242 static int plug_proxy_accepting (Plug p
, OSSocket sock
)
244 Proxy_Plug pp
= (Proxy_Plug
) p
;
245 Proxy_Socket ps
= pp
->proxy_socket
;
247 if (ps
->state
!= PROXY_STATE_ACTIVE
) {
248 ps
->accepting_sock
= sock
;
249 return ps
->negotiate(ps
, PROXY_CHANGE_ACCEPTING
);
251 return plug_accepting(ps
->plug
, sock
);
255 * This function can accept a NULL pointer as `addr', in which case
256 * it will only check the host name.
258 static int proxy_for_destination (SockAddr addr
, char *hostname
, int port
,
263 int hostip_len
, hostname_len
;
264 const char *exclude_list
;
267 * Check the host name and IP against the hard-coded
268 * representations of `localhost'.
270 if (!cfg
->even_proxy_localhost
&&
271 (sk_hostname_is_local(hostname
) ||
272 (addr
&& sk_address_is_local(addr
))))
273 return 0; /* do not proxy */
275 /* we want a string representation of the IP address for comparisons */
277 sk_getaddr(addr
, hostip
, 64);
278 hostip_len
= strlen(hostip
);
280 hostip_len
= 0; /* placate gcc; shouldn't be required */
282 hostname_len
= strlen(hostname
);
284 exclude_list
= cfg
->proxy_exclude_list
;
286 /* now parse the exclude list, and see if either our IP
287 * or hostname matches anything in it.
290 while (exclude_list
[s
]) {
291 while (exclude_list
[s
] &&
292 (isspace((unsigned char)exclude_list
[s
]) ||
293 exclude_list
[s
] == ',')) s
++;
295 if (!exclude_list
[s
]) break;
299 while (exclude_list
[e
] &&
300 (isalnum((unsigned char)exclude_list
[e
]) ||
301 exclude_list
[e
] == '-' ||
302 exclude_list
[e
] == '.' ||
303 exclude_list
[e
] == '*')) e
++;
305 if (exclude_list
[s
] == '*') {
306 /* wildcard at beginning of entry */
308 if ((addr
&& strnicmp(hostip
+ hostip_len
- (e
- s
- 1),
309 exclude_list
+ s
+ 1, e
- s
- 1) == 0) ||
310 strnicmp(hostname
+ hostname_len
- (e
- s
- 1),
311 exclude_list
+ s
+ 1, e
- s
- 1) == 0)
312 return 0; /* IP/hostname range excluded. do not use proxy. */
314 } else if (exclude_list
[e
-1] == '*') {
315 /* wildcard at end of entry */
317 if ((addr
&& strnicmp(hostip
, exclude_list
+ s
, e
- s
- 1) == 0) ||
318 strnicmp(hostname
, exclude_list
+ s
, e
- s
- 1) == 0)
319 return 0; /* IP/hostname range excluded. do not use proxy. */
322 /* no wildcard at either end, so let's try an absolute
323 * match (ie. a specific IP)
326 if (addr
&& strnicmp(hostip
, exclude_list
+ s
, e
- s
) == 0)
327 return 0; /* IP/hostname excluded. do not use proxy. */
328 if (strnicmp(hostname
, exclude_list
+ s
, e
- s
) == 0)
329 return 0; /* IP/hostname excluded. do not use proxy. */
334 /* Make sure we really have reached the next comma or end-of-string */
335 while (exclude_list
[s
] &&
336 !isspace((unsigned char)exclude_list
[s
]) &&
337 exclude_list
[s
] != ',') s
++;
340 /* no matches in the exclude list, so use the proxy */
344 SockAddr
name_lookup(char *host
, int port
, char **canonicalname
,
347 if (cfg
->proxy_type
!= PROXY_NONE
&&
349 proxy_for_destination(NULL
, host
, port
, cfg
)) {
350 *canonicalname
= dupstr(host
);
351 return sk_nonamelookup(host
);
354 return sk_namelookup(host
, canonicalname
);
357 Socket
new_connection(SockAddr addr
, char *hostname
,
358 int port
, int privport
,
359 int oobinline
, int nodelay
, int keepalive
,
360 Plug plug
, const Config
*cfg
)
362 static const struct socket_function_table socket_fn_table
= {
368 sk_proxy_set_private_ptr
,
369 sk_proxy_get_private_ptr
,
371 sk_proxy_socket_error
374 static const struct plug_function_table plug_fn_table
= {
381 if (cfg
->proxy_type
!= PROXY_NONE
&&
382 proxy_for_destination(addr
, hostname
, port
, cfg
))
387 char *proxy_canonical_name
;
390 if ((sret
= platform_new_connection(addr
, hostname
, port
, privport
,
391 oobinline
, nodelay
, keepalive
,
396 ret
= snew(struct Socket_proxy_tag
);
397 ret
->fn
= &socket_fn_table
;
398 ret
->cfg
= *cfg
; /* STRUCTURE COPY */
400 ret
->remote_addr
= addr
; /* will need to be freed on close */
401 ret
->remote_port
= port
;
404 ret
->pending_flush
= 0;
407 bufchain_init(&ret
->pending_input_data
);
408 bufchain_init(&ret
->pending_output_data
);
409 bufchain_init(&ret
->pending_oob_output_data
);
411 ret
->sub_socket
= NULL
;
412 ret
->state
= PROXY_STATE_NEW
;
413 ret
->negotiate
= NULL
;
415 if (cfg
->proxy_type
== PROXY_HTTP
) {
416 ret
->negotiate
= proxy_http_negotiate
;
417 } else if (cfg
->proxy_type
== PROXY_SOCKS4
) {
418 ret
->negotiate
= proxy_socks4_negotiate
;
419 } else if (cfg
->proxy_type
== PROXY_SOCKS5
) {
420 ret
->negotiate
= proxy_socks5_negotiate
;
421 } else if (cfg
->proxy_type
== PROXY_TELNET
) {
422 ret
->negotiate
= proxy_telnet_negotiate
;
424 ret
->error
= "Proxy error: Unknown proxy method";
428 /* create the proxy plug to map calls from the actual
429 * socket into our proxy socket layer */
430 pplug
= snew(struct Plug_proxy_tag
);
431 pplug
->fn
= &plug_fn_table
;
432 pplug
->proxy_socket
= ret
;
435 proxy_addr
= sk_namelookup(cfg
->proxy_host
,
436 &proxy_canonical_name
);
437 if (sk_addr_error(proxy_addr
) != NULL
) {
438 ret
->error
= "Proxy error: Unable to resolve proxy host name";
441 sfree(proxy_canonical_name
);
443 /* create the actual socket we will be using,
444 * connected to our proxy server and port.
446 ret
->sub_socket
= sk_new(proxy_addr
, cfg
->proxy_port
,
448 nodelay
, keepalive
, (Plug
) pplug
);
449 if (sk_socket_error(ret
->sub_socket
) != NULL
)
452 /* start the proxy negotiation process... */
453 sk_set_frozen(ret
->sub_socket
, 0);
454 ret
->negotiate(ret
, PROXY_CHANGE_NEW
);
459 /* no proxy, so just return the direct socket */
460 return sk_new(addr
, port
, privport
, oobinline
, nodelay
, keepalive
, plug
);
463 Socket
new_listener(char *srcaddr
, int port
, Plug plug
, int local_host_only
,
466 /* TODO: SOCKS (and potentially others) support inbound
467 * TODO: connections via the proxy. support them.
470 return sk_newlistener(srcaddr
, port
, plug
, local_host_only
);
473 /* ----------------------------------------------------------------------
474 * HTTP CONNECT proxy type.
477 static int get_line_end (char * data
, int len
)
483 if (data
[off
] == '\n') {
484 /* we have a newline */
487 /* is that the only thing on this line? */
488 if (off
<= 2) return off
;
490 /* if not, then there is the possibility that this header
491 * continues onto the next line, if it starts with a space
496 data
[off
+1] != ' ' &&
497 data
[off
+1] != '\t') return off
;
499 /* the line does continue, so we have to keep going
500 * until we see an the header's "real" end of line.
511 int proxy_http_negotiate (Proxy_Socket p
, int change
)
513 if (p
->state
== PROXY_STATE_NEW
) {
514 /* we are just beginning the proxy negotiate process,
515 * so we'll send off the initial bits of the request.
516 * for this proxy method, it's just a simple HTTP
519 char *buf
, dest
[512];
521 sk_getaddr(p
->remote_addr
, dest
, lenof(dest
));
523 buf
= dupprintf("CONNECT %s:%i HTTP/1.1\r\nHost: %s:%i\r\n",
524 dest
, p
->remote_port
, dest
, p
->remote_port
);
525 sk_write(p
->sub_socket
, buf
, strlen(buf
));
528 if (p
->cfg
.proxy_username
[0] || p
->cfg
.proxy_password
[0]) {
529 char buf
[sizeof(p
->cfg
.proxy_username
)+sizeof(p
->cfg
.proxy_password
)];
530 char buf2
[sizeof(buf
)*4/3 + 100];
532 sprintf(buf
, "%s:%s", p
->cfg
.proxy_username
, p
->cfg
.proxy_password
);
534 sprintf(buf2
, "Proxy-Authorization: Basic ");
535 for (i
= 0, j
= strlen(buf2
); i
< len
; i
+= 3, j
+= 4)
536 base64_encode_atom((unsigned char *)(buf
+i
),
537 (len
-i
> 3 ?
3 : len
-i
), buf2
+j
);
538 strcpy(buf2
+j
, "\r\n");
539 sk_write(p
->sub_socket
, buf2
, strlen(buf2
));
542 sk_write(p
->sub_socket
, "\r\n", 2);
548 if (change
== PROXY_CHANGE_CLOSING
) {
549 /* if our proxy negotiation process involves closing and opening
550 * new sockets, then we would want to intercept this closing
551 * callback when we were expecting it. if we aren't anticipating
552 * a socket close, then some error must have occurred. we'll
553 * just pass those errors up to the backend.
555 return plug_closing(p
->plug
, p
->closing_error_msg
,
556 p
->closing_error_code
,
557 p
->closing_calling_back
);
560 if (change
== PROXY_CHANGE_SENT
) {
561 /* some (or all) of what we wrote to the proxy was sent.
562 * we don't do anything new, however, until we receive the
563 * proxy's response. we might want to set a timer so we can
564 * timeout the proxy negotiation after a while...
569 if (change
== PROXY_CHANGE_ACCEPTING
) {
570 /* we should _never_ see this, as we are using our socket to
571 * connect to a proxy, not accepting inbound connections.
572 * what should we do? close the socket with an appropriate
575 return plug_accepting(p
->plug
, p
->accepting_sock
);
578 if (change
== PROXY_CHANGE_RECEIVE
) {
579 /* we have received data from the underlying socket, which
580 * we'll need to parse, process, and respond to appropriately.
589 int min_ver
, maj_ver
, status
;
591 /* get the status line */
592 len
= bufchain_size(&p
->pending_input_data
);
593 assert(len
> 0); /* or we wouldn't be here */
594 data
= snewn(len
+1, char);
595 bufchain_fetch(&p
->pending_input_data
, data
, len
);
597 * We must NUL-terminate this data, because Windows
598 * sscanf appears to require a NUL at the end of the
599 * string because it strlens it _first_. Sigh.
603 eol
= get_line_end(data
, len
);
610 /* We can't rely on whether the %n incremented the sscanf return */
611 if (sscanf((char *)data
, "HTTP/%i.%i %n",
612 &maj_ver
, &min_ver
, &status
) < 2 || status
== -1) {
613 plug_closing(p
->plug
, "Proxy error: HTTP response was absent",
614 PROXY_ERROR_GENERAL
, 0);
619 /* remove the status line from the input buffer. */
620 bufchain_consume(&p
->pending_input_data
, eol
);
621 if (data
[status
] != '2') {
625 while (eol
> status
&&
626 (data
[eol
-1] == '\r' || data
[eol
-1] == '\n'))
628 buf
= dupprintf("Proxy error: %s", data
+status
);
629 plug_closing(p
->plug
, buf
, PROXY_ERROR_GENERAL
, 0);
642 /* get headers. we're done when we get a
643 * header of length 2, (ie. just "\r\n")
646 len
= bufchain_size(&p
->pending_input_data
);
647 assert(len
> 0); /* or we wouldn't be here */
648 data
= snewn(len
, char);
650 bufchain_fetch(&p
->pending_input_data
, data
, len
);
652 eol
= get_line_end(datap
, len
);
659 bufchain_consume(&p
->pending_input_data
, eol
);
662 eol
= get_line_end(datap
, len
);
667 bufchain_consume(&p
->pending_input_data
, 2);
669 /* proxy activate will have dealt with
670 * whatever is left of the buffer */
680 plug_closing(p
->plug
, "Proxy error: unexpected proxy error",
681 PROXY_ERROR_UNEXPECTED
, 0);
685 /* ----------------------------------------------------------------------
689 /* SOCKS version 4 */
690 int proxy_socks4_negotiate (Proxy_Socket p
, int change
)
692 if (p
->state
== PROXY_CHANGE_NEW
) {
695 * version number (1 byte) = 4
696 * command code (1 byte)
699 * dest. port (2 bytes) [network order]
700 * dest. address (4 bytes)
701 * user ID (variable length, null terminated string)
704 int length
, type
, namelen
;
705 char *command
, addr
[4], hostname
[512];
707 type
= sk_addrtype(p
->remote_addr
);
708 if (type
== ADDRTYPE_IPV6
) {
709 plug_closing(p
->plug
, "Proxy error: SOCKS version 4 does"
710 " not support IPv6", PROXY_ERROR_GENERAL
, 0);
712 } else if (type
== ADDRTYPE_IPV4
) {
714 sk_addrcopy(p
->remote_addr
, addr
);
715 } else { /* type == ADDRTYPE_NAME */
716 assert(type
== ADDRTYPE_NAME
);
717 sk_getaddr(p
->remote_addr
, hostname
, lenof(hostname
));
718 namelen
= strlen(hostname
) + 1; /* include the NUL */
719 addr
[0] = addr
[1] = addr
[2] = 0;
723 length
= strlen(p
->cfg
.proxy_username
) + namelen
+ 9;
724 command
= snewn(length
, char);
725 strcpy(command
+ 8, p
->cfg
.proxy_username
);
727 command
[0] = 4; /* version 4 */
728 command
[1] = 1; /* CONNECT command */
731 command
[2] = (char) (p
->remote_port
>> 8) & 0xff;
732 command
[3] = (char) p
->remote_port
& 0xff;
735 memcpy(command
+ 4, addr
, 4);
738 memcpy(command
+ 8 + strlen(p
->cfg
.proxy_username
) + 1,
741 sk_write(p
->sub_socket
, command
, length
);
748 if (change
== PROXY_CHANGE_CLOSING
) {
749 /* if our proxy negotiation process involves closing and opening
750 * new sockets, then we would want to intercept this closing
751 * callback when we were expecting it. if we aren't anticipating
752 * a socket close, then some error must have occurred. we'll
753 * just pass those errors up to the backend.
755 return plug_closing(p
->plug
, p
->closing_error_msg
,
756 p
->closing_error_code
,
757 p
->closing_calling_back
);
760 if (change
== PROXY_CHANGE_SENT
) {
761 /* some (or all) of what we wrote to the proxy was sent.
762 * we don't do anything new, however, until we receive the
763 * proxy's response. we might want to set a timer so we can
764 * timeout the proxy negotiation after a while...
769 if (change
== PROXY_CHANGE_ACCEPTING
) {
770 /* we should _never_ see this, as we are using our socket to
771 * connect to a proxy, not accepting inbound connections.
772 * what should we do? close the socket with an appropriate
775 return plug_accepting(p
->plug
, p
->accepting_sock
);
778 if (change
== PROXY_CHANGE_RECEIVE
) {
779 /* we have received data from the underlying socket, which
780 * we'll need to parse, process, and respond to appropriately.
785 * version number (1 byte) = 4
786 * reply code (1 byte)
787 * 90 = request granted
788 * 91 = request rejected or failed
789 * 92 = request rejected due to lack of IDENTD on client
790 * 93 = request rejected due to difference in user ID
791 * (what we sent vs. what IDENTD said)
792 * dest. port (2 bytes)
793 * dest. address (4 bytes)
798 if (bufchain_size(&p
->pending_input_data
) < 8)
799 return 1; /* not got anything yet */
801 /* get the response */
802 bufchain_fetch(&p
->pending_input_data
, data
, 8);
805 plug_closing(p
->plug
, "Proxy error: SOCKS proxy responded with "
806 "unexpected reply code version",
807 PROXY_ERROR_GENERAL
, 0);
815 plug_closing(p
->plug
, "Proxy error: SOCKS server wanted IDENTD on client",
816 PROXY_ERROR_GENERAL
, 0);
819 plug_closing(p
->plug
, "Proxy error: Username and IDENTD on client don't agree",
820 PROXY_ERROR_GENERAL
, 0);
824 plug_closing(p
->plug
, "Proxy error: Error while communicating with proxy",
825 PROXY_ERROR_GENERAL
, 0);
831 bufchain_consume(&p
->pending_input_data
, 8);
835 /* proxy activate will have dealt with
836 * whatever is left of the buffer */
841 plug_closing(p
->plug
, "Proxy error: unexpected proxy error",
842 PROXY_ERROR_UNEXPECTED
, 0);
846 /* SOCKS version 5 */
847 int proxy_socks5_negotiate (Proxy_Socket p
, int change
)
849 if (p
->state
== PROXY_CHANGE_NEW
) {
852 * version number (1 byte) = 5
853 * number of available authentication methods (1 byte)
854 * available authentication methods (1 byte * previous value)
855 * authentication methods:
856 * 0x00 = no authentication
858 * 0x02 = username/password
865 command
[0] = 5; /* version 5 */
866 if (p
->cfg
.proxy_username
[0] || p
->cfg
.proxy_password
[0]) {
867 command
[1] = 2; /* two methods supported: */
868 command
[2] = 0x00; /* no authentication */
869 command
[3] = 0x02; /* username/password */
872 command
[1] = 1; /* one methods supported: */
873 command
[2] = 0x00; /* no authentication */
877 sk_write(p
->sub_socket
, command
, len
);
883 if (change
== PROXY_CHANGE_CLOSING
) {
884 /* if our proxy negotiation process involves closing and opening
885 * new sockets, then we would want to intercept this closing
886 * callback when we were expecting it. if we aren't anticipating
887 * a socket close, then some error must have occurred. we'll
888 * just pass those errors up to the backend.
890 return plug_closing(p
->plug
, p
->closing_error_msg
,
891 p
->closing_error_code
,
892 p
->closing_calling_back
);
895 if (change
== PROXY_CHANGE_SENT
) {
896 /* some (or all) of what we wrote to the proxy was sent.
897 * we don't do anything new, however, until we receive the
898 * proxy's response. we might want to set a timer so we can
899 * timeout the proxy negotiation after a while...
904 if (change
== PROXY_CHANGE_ACCEPTING
) {
905 /* we should _never_ see this, as we are using our socket to
906 * connect to a proxy, not accepting inbound connections.
907 * what should we do? close the socket with an appropriate
910 return plug_accepting(p
->plug
, p
->accepting_sock
);
913 if (change
== PROXY_CHANGE_RECEIVE
) {
914 /* we have received data from the underlying socket, which
915 * we'll need to parse, process, and respond to appropriately.
921 * version number (1 byte) = 5
922 * authentication method (1 byte)
923 * authentication methods:
924 * 0x00 = no authentication
926 * 0x02 = username/password
928 * 0xff = no acceptable methods
932 if (bufchain_size(&p
->pending_input_data
) < 2)
933 return 1; /* not got anything yet */
935 /* get the response */
936 bufchain_fetch(&p
->pending_input_data
, data
, 2);
939 plug_closing(p
->plug
, "Proxy error: SOCKS proxy returned unexpected version",
940 PROXY_ERROR_GENERAL
, 0);
944 if (data
[1] == 0x00) p
->state
= 2; /* no authentication needed */
945 else if (data
[1] == 0x01) p
->state
= 4; /* GSSAPI authentication */
946 else if (data
[1] == 0x02) p
->state
= 5; /* username/password authentication */
947 else if (data
[1] == 0x03) p
->state
= 6; /* CHAP authentication */
949 plug_closing(p
->plug
, "Proxy error: SOCKS proxy did not accept our authentication",
950 PROXY_ERROR_GENERAL
, 0);
953 bufchain_consume(&p
->pending_input_data
, 2);
958 /* password authentication reply format:
959 * version number (1 bytes) = 1
960 * reply code (1 byte)
966 if (bufchain_size(&p
->pending_input_data
) < 2)
967 return 1; /* not got anything yet */
969 /* get the response */
970 bufchain_fetch(&p
->pending_input_data
, data
, 2);
973 plug_closing(p
->plug
, "Proxy error: SOCKS password "
974 "subnegotiation contained wrong version number",
975 PROXY_ERROR_GENERAL
, 0);
981 plug_closing(p
->plug
, "Proxy error: SOCKS proxy refused"
982 " password authentication",
983 PROXY_ERROR_GENERAL
, 0);
987 bufchain_consume(&p
->pending_input_data
, 2);
988 p
->state
= 2; /* now proceed as authenticated */
994 * version number (1 byte) = 5
995 * command code (1 byte)
999 * reserved (1 byte) = 0x00
1000 * address type (1 byte)
1002 * 3 = domainname (first byte has length, no terminating null)
1004 * dest. address (variable)
1005 * dest. port (2 bytes) [network order]
1012 type
= sk_addrtype(p
->remote_addr
);
1013 if (type
== ADDRTYPE_IPV4
) {
1014 len
= 10; /* 4 hdr + 4 addr + 2 trailer */
1015 command
[3] = 1; /* IPv4 */
1016 sk_addrcopy(p
->remote_addr
, command
+4);
1017 } else if (type
== ADDRTYPE_IPV6
) {
1018 len
= 22; /* 4 hdr + 16 addr + 2 trailer */
1019 command
[3] = 4; /* IPv6 */
1020 sk_addrcopy(p
->remote_addr
, command
+4);
1022 assert(type
== ADDRTYPE_NAME
);
1024 sk_getaddr(p
->remote_addr
, command
+5, 256);
1025 command
[4] = strlen(command
+5);
1026 len
= 7 + command
[4]; /* 4 hdr, 1 len, N addr, 2 trailer */
1029 command
[0] = 5; /* version 5 */
1030 command
[1] = 1; /* CONNECT command */
1034 command
[len
-2] = (char) (p
->remote_port
>> 8) & 0xff;
1035 command
[len
-1] = (char) p
->remote_port
& 0xff;
1037 sk_write(p
->sub_socket
, command
, len
);
1043 if (p
->state
== 3) {
1046 * version number (1 bytes) = 5
1047 * reply code (1 byte)
1049 * 1 = general SOCKS server failure
1050 * 2 = connection not allowed by ruleset
1051 * 3 = network unreachable
1052 * 4 = host unreachable
1053 * 5 = connection refused
1055 * 7 = command not supported
1056 * 8 = address type not supported
1057 * reserved (1 byte) = x00
1058 * address type (1 byte)
1060 * 3 = domainname (first byte has length, no terminating null)
1062 * server bound address (variable)
1063 * server bound port (2 bytes) [network order]
1068 /* First 5 bytes of packet are enough to tell its length. */
1069 if (bufchain_size(&p
->pending_input_data
) < 5)
1070 return 1; /* not got anything yet */
1072 /* get the response */
1073 bufchain_fetch(&p
->pending_input_data
, data
, 5);
1076 plug_closing(p
->plug
, "Proxy error: SOCKS proxy returned wrong version number",
1077 PROXY_ERROR_GENERAL
, 0);
1084 strcpy(buf
, "Proxy error: ");
1087 case 1: strcat(buf
, "General SOCKS server failure"); break;
1088 case 2: strcat(buf
, "Connection not allowed by ruleset"); break;
1089 case 3: strcat(buf
, "Network unreachable"); break;
1090 case 4: strcat(buf
, "Host unreachable"); break;
1091 case 5: strcat(buf
, "Connection refused"); break;
1092 case 6: strcat(buf
, "TTL expired"); break;
1093 case 7: strcat(buf
, "Command not supported"); break;
1094 case 8: strcat(buf
, "Address type not supported"); break;
1095 default: sprintf(buf
+strlen(buf
),
1096 "Unrecognised SOCKS error code %d",
1100 plug_closing(p
->plug
, buf
, PROXY_ERROR_GENERAL
, 0);
1106 * Eat the rest of the reply packet.
1108 len
= 6; /* first 4 bytes, last 2 */
1110 case 1: len
+= 4; break; /* IPv4 address */
1111 case 4: len
+= 16; break;/* IPv6 address */
1112 case 3: len
+= (unsigned char)data
[4]; break; /* domain name */
1114 plug_closing(p
->plug
, "Proxy error: SOCKS proxy returned "
1115 "unrecognised address format",
1116 PROXY_ERROR_GENERAL
, 0);
1119 if (bufchain_size(&p
->pending_input_data
) < len
)
1120 return 1; /* not got whole reply yet */
1121 bufchain_consume(&p
->pending_input_data
, len
);
1128 if (p
->state
== 4) {
1129 /* TODO: Handle GSSAPI authentication */
1130 plug_closing(p
->plug
, "Proxy error: We don't support GSSAPI authentication",
1131 PROXY_ERROR_GENERAL
, 0);
1135 if (p
->state
== 5) {
1136 if (p
->cfg
.proxy_username
[0] || p
->cfg
.proxy_password
[0]) {
1137 char userpwbuf
[514];
1139 ulen
= strlen(p
->cfg
.proxy_username
);
1140 if (ulen
> 255) ulen
= 255; if (ulen
< 1) ulen
= 1;
1141 plen
= strlen(p
->cfg
.proxy_password
);
1142 if (plen
> 255) plen
= 255; if (plen
< 1) plen
= 1;
1143 userpwbuf
[0] = 1; /* version number of subnegotiation */
1144 userpwbuf
[1] = ulen
;
1145 memcpy(userpwbuf
+2, p
->cfg
.proxy_username
, ulen
);
1146 userpwbuf
[ulen
+2] = plen
;
1147 memcpy(userpwbuf
+ulen
+3, p
->cfg
.proxy_password
, plen
);
1148 sk_write(p
->sub_socket
, userpwbuf
, ulen
+ plen
+ 3);
1151 plug_closing(p
->plug
, "Proxy error: Server chose "
1152 "username/password authentication but we "
1154 PROXY_ERROR_GENERAL
, 0);
1158 if (p
->state
== 6) {
1159 /* TODO: Handle CHAP authentication */
1160 plug_closing(p
->plug
, "Proxy error: We don't support CHAP authentication",
1161 PROXY_ERROR_GENERAL
, 0);
1167 plug_closing(p
->plug
, "Proxy error: Unexpected proxy error",
1168 PROXY_ERROR_UNEXPECTED
, 0);
1172 /* ----------------------------------------------------------------------
1173 * `Telnet' proxy type.
1175 * (This is for ad-hoc proxies where you connect to the proxy's
1176 * telnet port and send a command such as `connect host port'. The
1177 * command is configurable, since this proxy type is typically not
1178 * standardised or at all well-defined.)
1181 char *format_telnet_command(SockAddr addr
, int port
, const Config
*cfg
)
1184 int retlen
= 0, retsize
= 0;
1186 #define ENSURE(n) do { \
1187 if (retsize < retlen + n) { \
1188 retsize = retlen + n + 512; \
1189 ret = sresize(ret, retsize, char); \
1193 /* we need to escape \\, \%, \r, \n, \t, \x??, \0???,
1194 * %%, %host, %port, %user, and %pass
1197 while (cfg
->proxy_telnet_command
[eo
] != 0) {
1199 /* scan forward until we hit end-of-line,
1200 * or an escape character (\ or %) */
1201 while (cfg
->proxy_telnet_command
[eo
] != 0 &&
1202 cfg
->proxy_telnet_command
[eo
] != '%' &&
1203 cfg
->proxy_telnet_command
[eo
] != '\\') eo
++;
1205 /* if we hit eol, break out of our escaping loop */
1206 if (cfg
->proxy_telnet_command
[eo
] == 0) break;
1208 /* if there was any unescaped text before the escape
1209 * character, send that now */
1212 memcpy(ret
+ retlen
, cfg
->proxy_telnet_command
+ so
, eo
- so
);
1218 /* if the escape character was the last character of
1219 * the line, we'll just stop and send it. */
1220 if (cfg
->proxy_telnet_command
[eo
] == 0) break;
1222 if (cfg
->proxy_telnet_command
[so
] == '\\') {
1224 /* we recognize \\, \%, \r, \n, \t, \x??.
1225 * anything else, we just send unescaped (including the \).
1228 switch (cfg
->proxy_telnet_command
[eo
]) {
1232 ret
[retlen
++] = '\\';
1238 ret
[retlen
++] = '%';
1244 ret
[retlen
++] = '\r';
1250 ret
[retlen
++] = '\n';
1256 ret
[retlen
++] = '\t';
1263 /* escaped hexadecimal value (ie. \xff) */
1264 unsigned char v
= 0;
1269 if (cfg
->proxy_telnet_command
[eo
] >= '0' &&
1270 cfg
->proxy_telnet_command
[eo
] <= '9')
1271 v
+= cfg
->proxy_telnet_command
[eo
] - '0';
1272 else if (cfg
->proxy_telnet_command
[eo
] >= 'a' &&
1273 cfg
->proxy_telnet_command
[eo
] <= 'f')
1274 v
+= cfg
->proxy_telnet_command
[eo
] - 'a' + 10;
1275 else if (cfg
->proxy_telnet_command
[eo
] >= 'A' &&
1276 cfg
->proxy_telnet_command
[eo
] <= 'F')
1277 v
+= cfg
->proxy_telnet_command
[eo
] - 'A' + 10;
1279 /* non hex character, so we abort and just
1280 * send the whole thing unescaped (including \x)
1283 ret
[retlen
++] = '\\';
1288 /* we only extract two hex characters */
1304 memcpy(ret
+retlen
, cfg
->proxy_telnet_command
+ so
, 2);
1311 /* % escape. we recognize %%, %host, %port, %user, %pass.
1312 * anything else, we just send unescaped (including the %).
1315 if (cfg
->proxy_telnet_command
[eo
] == '%') {
1317 ret
[retlen
++] = '%';
1320 else if (strnicmp(cfg
->proxy_telnet_command
+ eo
,
1324 sk_getaddr(addr
, dest
, lenof(dest
));
1325 destlen
= strlen(dest
);
1327 memcpy(ret
+retlen
, dest
, destlen
);
1331 else if (strnicmp(cfg
->proxy_telnet_command
+ eo
,
1333 char portstr
[8], portlen
;
1334 portlen
= sprintf(portstr
, "%i", port
);
1336 memcpy(ret
+ retlen
, portstr
, portlen
);
1340 else if (strnicmp(cfg
->proxy_telnet_command
+ eo
,
1342 int userlen
= strlen(cfg
->proxy_username
);
1344 memcpy(ret
+retlen
, cfg
->proxy_username
, userlen
);
1348 else if (strnicmp(cfg
->proxy_telnet_command
+ eo
,
1350 int passlen
= strlen(cfg
->proxy_password
);
1352 memcpy(ret
+retlen
, cfg
->proxy_password
, passlen
);
1357 /* we don't escape this, so send the % now, and
1358 * don't advance eo, so that we'll consider the
1359 * text immediately following the % as unescaped.
1362 ret
[retlen
++] = '%';
1366 /* resume scanning for additional escapes after this one. */
1370 /* if there is any unescaped text at the end of the line, send it */
1373 memcpy(ret
+ retlen
, cfg
->proxy_telnet_command
+ so
, eo
- so
);
1384 int proxy_telnet_negotiate (Proxy_Socket p
, int change
)
1386 if (p
->state
== PROXY_CHANGE_NEW
) {
1387 char *formatted_cmd
;
1389 formatted_cmd
= format_telnet_command(p
->remote_addr
, p
->remote_port
,
1392 sk_write(p
->sub_socket
, formatted_cmd
, strlen(formatted_cmd
));
1393 sfree(formatted_cmd
);
1399 if (change
== PROXY_CHANGE_CLOSING
) {
1400 /* if our proxy negotiation process involves closing and opening
1401 * new sockets, then we would want to intercept this closing
1402 * callback when we were expecting it. if we aren't anticipating
1403 * a socket close, then some error must have occurred. we'll
1404 * just pass those errors up to the backend.
1406 return plug_closing(p
->plug
, p
->closing_error_msg
,
1407 p
->closing_error_code
,
1408 p
->closing_calling_back
);
1411 if (change
== PROXY_CHANGE_SENT
) {
1412 /* some (or all) of what we wrote to the proxy was sent.
1413 * we don't do anything new, however, until we receive the
1414 * proxy's response. we might want to set a timer so we can
1415 * timeout the proxy negotiation after a while...
1420 if (change
== PROXY_CHANGE_ACCEPTING
) {
1421 /* we should _never_ see this, as we are using our socket to
1422 * connect to a proxy, not accepting inbound connections.
1423 * what should we do? close the socket with an appropriate
1426 return plug_accepting(p
->plug
, p
->accepting_sock
);
1429 if (change
== PROXY_CHANGE_RECEIVE
) {
1430 /* we have received data from the underlying socket, which
1431 * we'll need to parse, process, and respond to appropriately.
1436 /* proxy activate will have dealt with
1437 * whatever is left of the buffer */
1441 plug_closing(p
->plug
, "Proxy error: Unexpected proxy error",
1442 PROXY_ERROR_UNEXPECTED
, 0);