* gnus-art.el (gnus-save-all-headers): Mention it might be overridden.
[gnus] / lisp / dns.el
1 ;;; dns.el --- Domain Name Service lookups
2
3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: network
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30
31 (require 'mm-util)
32
33 (defvar dns-timeout 5
34   "How many seconds to wait when doing DNS queries.")
35
36 (defvar dns-servers nil
37   "Which DNS servers to query.
38 If nil, /etc/resolv.conf will be consulted.")
39
40 ;;; Internal code:
41
42 (defvar dns-query-types
43   '((A 1)
44     (NS 2)
45     (MD 3)
46     (MF 4)
47     (CNAME 5)
48     (SOA 6)
49     (MB 7)
50     (MG 8)
51     (MR 9)
52     (NULL 10)
53     (WKS 11)
54     (PTR 12)
55     (HINFO 13)
56     (MINFO 14)
57     (MX 15)
58     (TXT 16)
59     (AAAA 28) ; RFC3596
60     (SRV 33) ; RFC2782
61     (AXFR 252)
62     (MAILB 253)
63     (MAILA 254)
64     (* 255))
65   "Names of query types and their values.")
66
67 (defvar dns-classes
68   '((IN 1)
69     (CS 2)
70     (CH 3)
71     (HS 4))
72   "Classes of queries.")
73
74 (defun dns-write-bytes (value &optional length)
75   (let (bytes)
76     (dotimes (i (or length 1))
77       (push (% value 256) bytes)
78       (setq value (/ value 256)))
79     (dolist (byte bytes)
80       (insert byte))))
81
82 (defun dns-read-bytes (length)
83   (let ((value 0))
84     (dotimes (i length)
85       (setq value (logior (* value 256) (following-char)))
86       (forward-char 1))
87     value))
88
89 (defun dns-get (type spec)
90   (cadr (assq type spec)))
91
92 (defun dns-inverse-get (value spec)
93   (let ((found nil))
94     (while (and (not found)
95                 spec)
96       (if (eq value (cadr (car spec)))
97           (setq found (caar spec))
98         (pop spec)))
99     found))
100
101 (defun dns-write-name (name)
102   (dolist (part (split-string name "\\."))
103     (dns-write-bytes (length part))
104     (insert part))
105   (dns-write-bytes 0))
106
107 (defun dns-read-string-name (string buffer)
108   (mm-with-unibyte-buffer
109     (insert string)
110     (goto-char (point-min))
111     (dns-read-name buffer)))
112
113 (defun dns-read-name (&optional buffer)
114   (let ((ended nil)
115         (name nil)
116         length)
117     (while (not ended)
118       (setq length (dns-read-bytes 1))
119       (if (= 192 (logand length (lsh 3 6)))
120           (let ((offset (+ (* (logand 63 length) 256)
121                            (dns-read-bytes 1))))
122             (save-excursion
123               (when buffer
124                 (set-buffer buffer))
125               (goto-char (1+ offset))
126               (setq ended (dns-read-name buffer))))
127         (if (zerop length)
128             (setq ended t)
129           (push (buffer-substring (point)
130                                   (progn (forward-char length) (point)))
131                 name))))
132     (if (stringp ended)
133         (if (null name)
134             ended
135           (concat (mapconcat 'identity (nreverse name) ".") "." ended))
136       (mapconcat 'identity (nreverse name) "."))))
137
138 (defun dns-write (spec &optional tcp-p)
139   "Write a DNS packet according to SPEC.
140 If TCP-P, the first two bytes of the package with be the length field."
141   (with-temp-buffer
142     (dns-write-bytes (dns-get 'id spec) 2)
143     (dns-write-bytes
144      (logior
145       (lsh (if (dns-get 'response-p spec) 1 0) -7)
146       (lsh
147        (cond
148         ((eq (dns-get 'opcode spec) 'query) 0)
149         ((eq (dns-get 'opcode spec) 'inverse-query) 1)
150         ((eq (dns-get 'opcode spec) 'status) 2)
151         (t (error "No such opcode: %s" (dns-get 'opcode spec))))
152        -3)
153       (lsh (if (dns-get 'authoritative-p spec) 1 0) -2)
154       (lsh (if (dns-get 'truncated-p spec) 1 0) -1)
155       (lsh (if (dns-get 'recursion-desired-p spec) 1 0) 0)))
156     (dns-write-bytes
157      (cond 
158       ((eq (dns-get 'response-code spec) 'no-error) 0)
159       ((eq (dns-get 'response-code spec) 'format-error) 1)
160       ((eq (dns-get 'response-code spec) 'server-failure) 2)
161       ((eq (dns-get 'response-code spec) 'name-error) 3)
162       ((eq (dns-get 'response-code spec) 'not-implemented) 4)
163       ((eq (dns-get 'response-code spec) 'refused) 5)
164       (t 0)))
165     (dns-write-bytes (length (dns-get 'queries spec)) 2)
166     (dns-write-bytes (length (dns-get 'answers spec)) 2)
167     (dns-write-bytes (length (dns-get 'authorities spec)) 2)
168     (dns-write-bytes (length (dns-get 'additionals spec)) 2)
169     (dolist (query (dns-get 'queries spec))
170       (dns-write-name (car query))
171       (dns-write-bytes (cadr (assq (or (dns-get 'type query) 'A)
172                                    dns-query-types)) 2)
173       (dns-write-bytes (cadr (assq (or (dns-get 'class query) 'IN)
174                                    dns-classes)) 2))
175     (dolist (slot '(answers authorities additionals))
176       (dolist (resource (dns-get slot spec))
177         (dns-write-name (car resource))
178       (dns-write-bytes (cadr (assq (dns-get 'type resource) dns-query-types))
179                        2)
180       (dns-write-bytes (cadr (assq (dns-get 'class resource) dns-classes))
181                        2)
182       (dns-write-bytes (dns-get 'ttl resource) 4)
183       (dns-write-bytes (length (dns-get 'data resource)) 2)
184       (insert (dns-get 'data resource))))
185     (when tcp-p
186       (goto-char (point-min))
187       (dns-write-bytes (buffer-size) 2))
188     (buffer-string)))
189
190 (defun dns-read (packet)
191   (mm-with-unibyte-buffer
192     (let ((spec nil)
193           queries answers authorities additionals)
194       (insert packet)
195       (goto-char (point-min))
196       (push (list 'id (dns-read-bytes 2)) spec)
197       (let ((byte (dns-read-bytes 1)))
198         (push (list 'response-p (if (zerop (logand byte (lsh 1 7))) nil t))
199               spec)
200         (let ((opcode (logand byte (lsh 7 3))))
201           (push (list 'opcode
202                       (cond ((eq opcode 0) 'query)
203                             ((eq opcode 1) 'inverse-query)
204                             ((eq opcode 2) 'status)))
205                 spec))
206         (push (list 'authoritative-p (if (zerop (logand byte (lsh 1 2)))
207                                          nil t)) spec)
208         (push (list 'truncated-p (if (zerop (logand byte (lsh 1 2))) nil t))
209               spec)
210         (push (list 'recursion-desired-p
211                     (if (zerop (logand byte (lsh 1 0))) nil t)) spec))
212       (let ((rc (logand (dns-read-bytes 1) 15)))
213         (push (list 'response-code
214                     (cond
215                      ((eq rc 0) 'no-error)
216                      ((eq rc 1) 'format-error)
217                      ((eq rc 2) 'server-failure)
218                      ((eq rc 3) 'name-error)
219                      ((eq rc 4) 'not-implemented)
220                      ((eq rc 5) 'refused)))
221               spec))
222       (setq queries (dns-read-bytes 2))
223       (setq answers (dns-read-bytes 2))
224       (setq authorities (dns-read-bytes 2))
225       (setq additionals (dns-read-bytes 2))
226       (let ((qs nil))
227         (dotimes (i queries)
228           (push (list (dns-read-name)
229                       (list 'type (dns-inverse-get (dns-read-bytes 2)
230                                                    dns-query-types))
231                       (list 'class (dns-inverse-get (dns-read-bytes 2)
232                                                     dns-classes)))
233                 qs))
234         (push (list 'queries qs) spec))
235     (dolist (slot '(answers authorities additionals))
236       (let ((qs nil)
237             type)
238         (dotimes (i (symbol-value slot))
239           (push (list (dns-read-name)
240                       (list 'type
241                             (setq type (dns-inverse-get (dns-read-bytes 2)
242                                                         dns-query-types)))
243                       (list 'class (dns-inverse-get (dns-read-bytes 2)
244                                                     dns-classes))
245                       (list 'ttl (dns-read-bytes 4))
246                       (let ((length (dns-read-bytes 2)))
247                         (list 'data
248                               (dns-read-type
249                                (buffer-substring
250                                 (point)
251                                 (progn (forward-char length) (point)))
252                                type))))
253                 qs))
254         (push (list slot qs) spec)))
255     (nreverse spec))))
256
257 (defun dns-read-int32 ()
258   ;; Full 32 bit Integers can't be handled by Emacs.  If we use
259   ;; floats, it works.
260   (format "%.0f" (+ (* (dns-read-bytes 1) 16777216.0)
261                     (dns-read-bytes 3))))