moved my entry from etc/ChangeLog to lisp/ChangeLog
[emacs.git] / lisp / net / socks.el
blobee2bc0c1d2d13df31aedd5c2a60a9c3ae364a3b6
1 ;;; socks.el --- A Socks v5 Client for Emacs
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2002,
4 ;; 2007 Free Software Foundation, Inc.
6 ;; Author: William M. Perry <wmperry@gnu.org>
7 ;; Dave Love <fx@gnu.org>
8 ;; Keywords: comm, firewalls
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; This is an implementation of the SOCKS v5 protocol as defined in
30 ;; RFC 1928.
32 ;; TODO
33 ;; - Finish the redirection rules stuff
34 ;; - Implement composition of servers. Recursively evaluate the
35 ;; redirection rules and do SOCKS-over-HTTP and SOCKS-in-SOCKS
37 (eval-when-compile
38 (require 'wid-edit))
39 (require 'custom)
41 (if (not (fboundp 'split-string))
42 (defun split-string (string &optional pattern)
43 "Return a list of substrings of STRING which are separated by PATTERN.
44 If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
45 (or pattern
46 (setq pattern "[ \f\t\n\r\v]+"))
47 (let (parts (start 0))
48 (while (string-match pattern string start)
49 (setq parts (cons (substring string start (match-beginning 0)) parts)
50 start (match-end 0)))
51 (nreverse (cons (substring string start) parts)))))
52 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
53 ;;; Custom widgets
54 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
55 (define-widget 'dynamic-choice 'menu-choice
56 "A pretty simple dynamic dropdown list"
57 :format "%[%t%]: %v"
58 :tag "Network"
59 :case-fold t
60 :void '(item :format "invalid (%t)\n")
61 :value-create 's5-widget-value-create
62 :value-delete 'widget-children-value-delete
63 :value-get 'widget-choice-value-get
64 :value-inline 'widget-choice-value-inline
65 :mouse-down-action 'widget-choice-mouse-down-action
66 :action 'widget-choice-action
67 :error "Make a choice"
68 :validate 'widget-choice-validate
69 :match 's5-dynamic-choice-match
70 :match-inline 's5-dynamic-choice-match-inline)
72 (defun s5-dynamic-choice-match (widget value)
73 (let ((choices (funcall (widget-get widget :choice-function)))
74 current found)
75 (while (and choices (not found))
76 (setq current (car choices)
77 choices (cdr choices)
78 found (widget-apply current :match value)))
79 found))
81 (defun s5-dynamic-choice-match-inline (widget value)
82 (let ((choices (funcall (widget-get widget :choice-function)))
83 current found)
84 (while (and choices (not found))
85 (setq current (car choices)
86 choices (cdr choices)
87 found (widget-match-inline current value)))
88 found))
90 (defun s5-widget-value-create (widget)
91 (let ((choices (funcall (widget-get widget :choice-function)))
92 (value (widget-get widget :value)))
93 (if (not value)
94 (widget-put widget :value (widget-value (car choices))))
95 (widget-put widget :args choices)
96 (widget-choice-value-create widget)))
98 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
99 ;;; Customization support
100 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
101 (defgroup socks nil
102 "SOCKS Support"
103 :prefix "socks-"
104 :group 'processes)
106 '(defcustom socks-server-aliases nil
107 "A list of server aliases for use in access control and filtering rules."
108 :group 'socks
109 :type '(repeat (list :format "%v"
110 :value ("" "" 1080 5)
111 (string :tag "Alias")
112 (string :tag "Hostname/IP Address")
113 (integer :tag "Port #")
114 (choice :tag "SOCKS Version"
115 (integer :tag "SOCKS v4" :value 4)
116 (integer :tag "SOCKS v5" :value 5)))))
118 '(defcustom socks-network-aliases
119 '(("Anywhere" (netmask "0.0.0.0" "0.0.0.0")))
120 "A list of network aliases for use in subsequent rules."
121 :group 'socks
122 :type '(repeat (list :format "%v"
123 :value (netmask "" "255.255.255.0")
124 (string :tag "Alias")
125 (radio-button-choice
126 :format "%v"
127 (list :tag "IP address range"
128 (const :format "" :value range)
129 (string :tag "From")
130 (string :tag "To"))
131 (list :tag "IP address/netmask"
132 (const :format "" :value netmask)
133 (string :tag "IP Address")
134 (string :tag "Netmask"))
135 (list :tag "Domain Name"
136 (const :format "" :value domain)
137 (string :tag "Domain name"))
138 (list :tag "Unique hostname/IP address"
139 (const :format "" :value exact)
140 (string :tag "Hostname/IP Address"))))))
142 '(defun s5-servers-filter ()
143 (if socks-server-aliases
144 (mapcar (lambda (x) (list 'const :tag (car x) :value (car x))) s5-server-aliases)
145 '((const :tag "No aliases defined" :value nil))))
147 '(defun s5-network-aliases-filter ()
148 (mapcar (lambda (x) (list 'const :tag (car x) :value (car x)))
149 socks-network-aliases))
151 '(defcustom socks-redirection-rules
153 "A list of redirection rules."
154 :group 'socks
155 :type '(repeat (list :format "%v"
156 :value ("Anywhere" nil)
157 (dynamic-choice :choice-function s5-network-aliases-filter
158 :tag "Destination network")
159 (radio-button-choice
160 :tag "Connection type"
161 (const :tag "Direct connection" :value nil)
162 (dynamic-choice :format "%t: %[%v%]"
163 :choice-function s5-servers-filter
164 :tag "Proxy chain via")))))
166 (defcustom socks-server
167 (list "Default server" "socks" 1080 5)
169 :group 'socks
170 :type '(list
171 (string :format "" :value "Default server")
172 (string :tag "Server")
173 (integer :tag "Port")
174 (radio-button-choice :tag "SOCKS Version"
175 :format "%t: %v"
176 (const :tag "SOCKS v4 " :format "%t" :value 4)
177 (const :tag "SOCKS v5" :format "%t" :value 5))))
180 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
181 ;;; Get down to the nitty gritty
182 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
183 (defconst socks-version 5)
184 (defvar socks-debug nil)
186 ;; Common socks v5 commands
187 (defconst socks-connect-command 1)
188 (defconst socks-bind-command 2)
189 (defconst socks-udp-associate-command 3)
191 ;; Miscellaneous other socks constants
192 (defconst socks-authentication-null 0)
193 (defconst socks-authentication-failure 255)
195 ;; Response codes
196 (defconst socks-response-success 0)
197 (defconst socks-response-general-failure 1)
198 (defconst socks-response-access-denied 2)
199 (defconst socks-response-network-unreachable 3)
200 (defconst socks-response-host-unreachable 4)
201 (defconst socks-response-connection-refused 5)
202 (defconst socks-response-ttl-expired 6)
203 (defconst socks-response-cmd-not-supported 7)
204 (defconst socks-response-address-not-supported 8)
206 (defvar socks-errors
207 '("Succeeded"
208 "General SOCKS server failure"
209 "Connection not allowed by ruleset"
210 "Network unreachable"
211 "Host unreachable"
212 "Connection refused"
213 "Time-to-live expired"
214 "Command not supported"
215 "Address type not supported"))
217 ;; The socks v5 address types
218 (defconst socks-address-type-v4 1)
219 (defconst socks-address-type-name 3)
220 (defconst socks-address-type-v6 4)
222 ;; Base variables
223 (defvar socks-timeout 5)
224 (defvar socks-connections (make-hash-table :size 13))
226 ;; Miscellaneous stuff for authentication
227 (defvar socks-authentication-methods nil)
228 (defvar socks-username (user-login-name))
229 (defvar socks-password nil)
231 (defun socks-register-authentication-method (id desc callback)
232 (let ((old (assq id socks-authentication-methods)))
233 (if old
234 (setcdr old (cons desc callback))
235 (setq socks-authentication-methods
236 (cons (cons id (cons desc callback))
237 socks-authentication-methods)))))
239 (defun socks-unregister-authentication-method (id)
240 (let ((old (assq id socks-authentication-methods)))
241 (if old
242 (setq socks-authentication-methods
243 (delq old socks-authentication-methods)))))
245 (socks-register-authentication-method 0 "No authentication" 'identity)
247 (defun socks-build-auth-list ()
248 (let ((num 0)
249 (retval ""))
250 (mapcar
251 (function
252 (lambda (x)
253 (if (fboundp (cdr (cdr x)))
254 (setq retval (format "%s%c" retval (car x))
255 num (1+ num)))))
256 (reverse socks-authentication-methods))
257 (format "%c%s" num retval)))
259 (defconst socks-state-waiting-for-auth 0)
260 (defconst socks-state-submethod-negotiation 1)
261 (defconst socks-state-authenticated 2)
262 (defconst socks-state-waiting 3)
263 (defconst socks-state-connected 4)
265 (defmacro socks-wait-for-state-change (proc htable cur-state)
267 (while (and (= (gethash 'state (, htable)) (, cur-state))
268 (memq (process-status (, proc)) '(run open)))
269 (accept-process-output (, proc) socks-timeout))))
271 (defun socks-filter (proc string)
272 (let ((info (gethash proc socks-connections))
273 state version desired-len)
274 (or info (error "socks-filter called on non-SOCKS connection %S" proc))
275 (setq state (gethash 'state info))
276 (cond
277 ((= state socks-state-waiting-for-auth)
278 (puthash 'scratch (concat string (gethash 'scratch info)) info)
279 (setq string (gethash 'scratch info))
280 (if (< (length string) 2)
281 nil ; We need to spin some more
282 (puthash 'authtype (aref string 1) info)
283 (puthash 'scratch (substring string 2 nil) info)
284 (puthash 'state socks-state-submethod-negotiation info)))
285 ((= state socks-state-submethod-negotiation)
287 ((= state socks-state-authenticated)
289 ((= state socks-state-waiting)
290 (puthash 'scratch (concat string (gethash 'scratch info)) info)
291 (setq string (gethash 'scratch info))
292 (setq version (gethash 'server-protocol info))
293 (cond
294 ((equal version 'http)
295 (if (not (string-match "\r\n\r\n" string))
296 nil ; Need to spin some more
297 (puthash 'state socks-state-connected info)
298 (puthash 'reply 0 info)
299 (puthash 'response string info)))
300 ((equal version 4)
301 (if (< (length string) 2)
302 nil ; Can't know how much to read yet
303 (setq desired-len
304 (+ 4 ; address length
305 2 ; port
306 2 ; initial data
308 (if (< (length string) desired-len)
309 nil ; need to spin some more
310 (let ((response (aref string 1)))
311 (if (= response 90)
312 (setq response 0))
313 (puthash 'state socks-state-connected info)
314 (puthash 'reply response info)
315 (puthash 'response string info)))))
316 ((equal version 5)
317 (if (< (length string) 4)
319 (setq desired-len
320 (+ 6 ; Standard socks header
321 (cond
322 ((= (aref string 3) socks-address-type-v4) 4)
323 ((= (aref string 3) socks-address-type-v6) 16)
324 ((= (aref string 3) socks-address-type-name)
325 (if (< (length string) 5)
327 (+ 1 (aref string 4)))))))
328 (if (< (length string) desired-len)
329 nil ; Need to spin some more
330 (puthash 'state socks-state-connected info)
331 (puthash 'reply (aref string 1) info)
332 (puthash 'response string info))))))
333 ((= state socks-state-connected)
339 (defun socks-open-connection (server-info)
340 (interactive)
341 (save-excursion
342 (let ((proc (socks-original-open-network-stream "socks"
344 (nth 1 server-info)
345 (nth 2 server-info)))
346 (info (make-hash-table :size 13))
347 (authtype nil)
348 version)
350 ;; Initialize process and info about the process
351 (set-process-filter proc 'socks-filter)
352 (set-process-query-on-exit-flag proc nil)
353 (puthash proc info socks-connections)
354 (puthash 'state socks-state-waiting-for-auth info)
355 (puthash 'authtype socks-authentication-failure info)
356 (puthash 'server-protocol (nth 3 server-info) info)
357 (puthash 'server-name (nth 1 server-info) info)
358 (setq version (nth 3 server-info))
359 (cond
360 ((equal version 'http)
361 ;; Don't really have to do any connection setup under http
362 nil)
363 ((equal version 4)
364 ;; Don't really have to do any connection setup under v4
365 nil)
366 ((equal version 5)
367 ;; Need to handle all the authentication crap under v5
368 ;; Send what we think we can handle for authentication types
369 (process-send-string proc (format "%c%s" socks-version
370 (socks-build-auth-list)))
372 ;; Basically just do a select() until we change states.
373 (socks-wait-for-state-change proc info socks-state-waiting-for-auth)
374 (setq authtype (gethash 'authtype info))
375 (cond
376 ((= authtype socks-authentication-null)
377 (and socks-debug (message "No authentication necessary")))
378 ((= authtype socks-authentication-failure)
379 (error "No acceptable authentication methods found."))
381 (let* ((auth-type (gethash 'authtype info))
382 (auth-handler (assoc auth-type socks-authentication-methods))
383 (auth-func (and auth-handler (cdr (cdr auth-handler))))
384 (auth-desc (and auth-handler (car (cdr auth-handler)))))
385 (set-process-filter proc nil)
386 (if (and auth-func (fboundp auth-func)
387 (funcall auth-func proc))
388 nil ; We succeeded!
389 (delete-process proc)
390 (error "Failed to use auth method: %s (%d)"
391 (or auth-desc "Unknown") auth-type))
395 (puthash 'state socks-state-authenticated info)
396 (set-process-filter proc 'socks-filter)))
397 proc)))
399 (defun socks-send-command (proc command atype address port)
400 (let ((addr (cond
401 ((or (= atype socks-address-type-v4)
402 (= atype socks-address-type-v6))
403 address)
404 ((= atype socks-address-type-name)
405 (format "%c%s" (length address) address))
407 (error "Unkown address type: %d" atype))))
408 (info (gethash proc socks-connections))
409 request version)
410 (or info (error "socks-send-command called on non-SOCKS connection %S"
411 proc))
412 (puthash 'state socks-state-waiting info)
413 (setq version (gethash 'server-protocol info))
414 (cond
415 ((equal version 'http)
416 (setq request (format (eval-when-compile
417 (concat
418 "CONNECT %s:%d HTTP/1.0\r\n"
419 "User-Agent: Emacs/SOCKS v1.0\r\n"
420 "\r\n"))
421 (cond
422 ((equal atype socks-address-type-name) address)
424 (error "Unsupported address type for HTTP: %d" atype)))
425 port)))
426 ((equal version 4)
427 (setq request (format
428 "%c%c%c%c%s%s%c"
429 version ; version
430 command ; command
431 (lsh port -8) ; port, high byte
432 (- port (lsh (lsh port -8) 8)) ; port, low byte
433 addr ; address
434 (user-full-name) ; username
435 0 ; terminate username
437 ((equal version 5)
438 (setq request (format
439 "%c%c%c%c%s%c%c"
440 version ; version
441 command ; command
442 0 ; reserved
443 atype ; address type
444 addr ; address
445 (lsh port -8) ; port, high byte
446 (- port (lsh (lsh port -8) 8)) ; port, low byte
449 (error "Unknown protocol version: %d" version)))
450 (process-send-string proc request)
451 (socks-wait-for-state-change proc info socks-state-waiting)
452 (process-status proc)
453 (if (= (or (gethash 'reply info) 1) socks-response-success)
454 nil ; Sweet sweet success!
455 (delete-process proc)
456 (error "SOCKS: %s" (nth (or (gethash 'reply info) 1) socks-errors)))
457 proc))
460 ;; Replacement functions for open-network-stream, etc.
461 (defvar socks-noproxy nil
462 "*List of regexps matching hosts that we should not socksify connections to")
464 (defun socks-find-route (host service)
465 (let ((route socks-server)
466 (noproxy socks-noproxy))
467 (while noproxy
468 (if (eq ?! (aref (car noproxy) 0))
469 (if (string-match (substring (car noproxy) 1) host)
470 (setq noproxy nil))
471 (if (string-match (car noproxy) host)
472 (setq route nil
473 noproxy nil)))
474 (setq noproxy (cdr noproxy)))
475 route))
477 (defvar socks-override-functions nil
478 "*Whether to overwrite the open-network-stream function with the SOCKSified
479 version.")
481 (if (fboundp 'socks-original-open-network-stream)
482 nil ; Do nothing, we've been here already
483 (defalias 'socks-original-open-network-stream
484 (symbol-function 'open-network-stream))
485 (if socks-override-functions
486 (defalias 'open-network-stream 'socks-open-network-stream)))
488 (defvar socks-services-file "/etc/services")
489 (defvar socks-tcp-services (make-hash-table :size 13 :test 'equal))
490 (defvar socks-udp-services (make-hash-table :size 13 :test 'equal))
492 (defun socks-parse-services ()
493 (if (not (and (file-exists-p socks-services-file)
494 (file-readable-p socks-services-file)))
495 (error "Could not find services file: %s" socks-services-file))
496 (save-excursion
497 (clrhash socks-tcp-services)
498 (clrhash socks-udp-services)
499 (set-buffer (get-buffer-create " *socks-tmp*"))
500 (erase-buffer)
501 (insert-file-contents socks-services-file)
502 ;; Nuke comments
503 (goto-char (point-min))
504 (while (re-search-forward "#.*" nil t)
505 (replace-match ""))
506 ;; Nuke empty lines
507 (goto-char (point-min))
508 (while (re-search-forward "^[ \t\n]+" nil t)
509 (replace-match ""))
510 ;; Now find all the lines
511 (goto-char (point-min))
512 (let (name port type)
513 (while (re-search-forward "^\\([^ \t]+\\)[ \t]+\\([0-9]+\\)/\\([a-z]+\\)"
514 nil t)
515 (setq name (downcase (match-string 1))
516 port (string-to-number (match-string 2))
517 type (downcase (match-string 3)))
518 (puthash name port (if (equal type "udp")
519 socks-udp-services
520 socks-tcp-services))))))
522 (defun socks-find-services-entry (service &optional udp)
523 "Return the port # associated with SERVICE"
524 (if (= (hash-table-count socks-tcp-services) 0)
525 (socks-parse-services))
526 (gethash (downcase service)
527 (if udp socks-udp-services socks-tcp-services)))
529 (defun socks-open-network-stream (name buffer host service)
530 (let* ((route (socks-find-route host service))
531 proc info version atype)
532 (if (not route)
533 (socks-original-open-network-stream name buffer host service)
534 (setq proc (socks-open-connection route)
535 info (gethash proc socks-connections)
536 version (gethash 'server-protocol info))
537 (cond
538 ((equal version 4)
539 (setq host (socks-nslookup-host host))
540 (if (not (listp host))
541 (error "Could not get IP address for: %s" host))
542 (setq host (apply 'format "%c%c%c%c" host))
543 (setq atype socks-address-type-v4))
545 (setq atype socks-address-type-name)))
546 (socks-send-command proc
547 socks-connect-command
548 atype
549 host
550 (if (stringp service)
551 (socks-find-services-entry service)
552 service))
553 (puthash 'buffer buffer info)
554 (puthash 'host host info)
555 (puthash 'service host info)
556 (set-process-filter proc nil)
557 (set-process-buffer proc (if buffer (get-buffer-create buffer)))
558 proc)))
560 ;; Authentication modules go here
562 ;; Basic username/password authentication, ala RFC 1929
563 (socks-register-authentication-method 2 "Username/Password"
564 'socks-username/password-auth)
566 (defconst socks-username/password-auth-version 1)
568 (defun socks-username/password-auth-filter (proc str)
569 (let ((info (gethash proc socks-connections))
570 state desired-len)
571 (or info (error "socks-filter called on non-SOCKS connection %S" proc))
572 (setq state (gethash 'state info))
573 (puthash 'scratch (concat (gethash 'scratch info) str) info)
574 (if (< (length (gethash 'scratch info)) 2)
576 (puthash 'password-auth-status (aref (gethash 'scratch info) 1) info)
577 (puthash 'state socks-state-authenticated info))))
579 (defun socks-username/password-auth (proc)
580 (let* ((info (gethash proc socks-connections))
581 (state (gethash 'state info)))
582 (if (not socks-password)
583 (setq socks-password (read-passwd
584 (format "Password for %s@%s: "
585 socks-username
586 (gethash 'server-name info)))))
587 (puthash 'scratch "" info)
588 (set-process-filter proc 'socks-username/password-auth-filter)
589 (process-send-string proc
590 (format "%c%c%s%c%s"
591 socks-username/password-auth-version
592 (length socks-username)
593 socks-username
594 (length socks-password)
595 socks-password))
596 (socks-wait-for-state-change proc info state)
597 (= (gethash 'password-auth-status info) 0)))
600 ;; More advanced GSS/API stuff, not yet implemented - volunteers?
601 ;; (socks-register-authentication-method 1 "GSS/API" 'socks-gssapi-auth)
603 (defun socks-gssapi-auth (proc)
604 nil)
607 ;; CHAP stuff
608 ;; (socks-register-authentication-method 3 "CHAP" 'socks-chap-auth)
609 (defun socks-chap-auth (proc)
610 nil)
613 ;; CRAM stuff
614 ;; (socks-register-authentication-method 5 "CRAM" 'socks-cram-auth)
615 (defun socks-cram-auth (proc)
616 nil)
619 (defcustom socks-nslookup-program "nslookup"
620 "*If non-NIL then a string naming the nslookup program."
621 :type '(choice (const :tag "None" :value nil) string)
622 :group 'socks)
624 (defun socks-nslookup-host (host)
625 "Attempt to resolve the given HOSTNAME using nslookup if possible."
626 (interactive "sHost: ")
627 (if socks-nslookup-program
628 (let ((proc (start-process " *nslookup*" " *nslookup*"
629 socks-nslookup-program host))
630 (res host))
631 (set-process-query-on-exit-flag proc nil)
632 (save-excursion
633 (set-buffer (process-buffer proc))
634 (while (progn
635 (accept-process-output proc)
636 (memq (process-status proc) '(run open))))
637 (goto-char (point-min))
638 (if (re-search-forward "Name:.*\nAddress\\(es\\)?: *\\([0-9.]+\\)$" nil t)
639 (progn
640 (setq res (buffer-substring (match-beginning 2)
641 (match-end 2))
642 res (mapcar 'string-to-int (split-string res "\\.")))))
643 (kill-buffer (current-buffer)))
644 res)
645 host))
647 (provide 'socks)
649 ;; arch-tag: 67aef0d9-f4f7-4056-89c3-b4c9bf93ce7f
650 ;;; socks.el ends here