Mercurial > emacs
comparison lisp/sha1.el @ 86919:f7d29ef23ff8
Move here from gnus/.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Sat, 01 Dec 2007 21:04:51 +0000 |
parents | |
children | 107ccd98fa12 |
comparison
equal
deleted
inserted
replaced
86918:8ce3c3821144 | 86919:f7d29ef23ff8 |
---|---|
1 ;;; sha1.el --- SHA1 Secure Hash Algorithm in Emacs-Lisp | |
2 | |
3 ;; Copyright (C) 1999, 2001, 2002, 2003, 2004, | |
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc. | |
5 | |
6 ;; Author: Shuhei KOBAYASHI <shuhei@aqua.ocn.ne.jp> | |
7 ;; Keywords: SHA1, FIPS 180-1 | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 3, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
24 ;; Boston, MA 02110-1301, USA. | |
25 | |
26 ;;; Commentary: | |
27 | |
28 ;; This program is implemented from the definition of SHA-1 in FIPS PUB | |
29 ;; 180-1 (Federal Information Processing Standards Publication 180-1), | |
30 ;; "Announcing the Standard for SECURE HASH STANDARD". | |
31 ;; <URL:http://www.itl.nist.gov/div897/pubs/fip180-1.htm> | |
32 ;; (EXCEPTION; two optimizations taken from GnuPG/cipher/sha1.c) | |
33 ;; | |
34 ;; Test cases from FIPS PUB 180-1. | |
35 ;; | |
36 ;; (sha1 "abc") | |
37 ;; => a9993e364706816aba3e25717850c26c9cd0d89d | |
38 ;; | |
39 ;; (sha1 "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq") | |
40 ;; => 84983e441c3bd26ebaae4aa1f95129e5e54670f1 | |
41 ;; | |
42 ;; (sha1 (make-string 1000000 ?a)) | |
43 ;; => 34aa973cd4c4daa4f61eeb2bdbad27316534016f | |
44 ;; | |
45 ;; BUGS: | |
46 ;; * It is assumed that length of input string is less than 2^29 bytes. | |
47 ;; * It is caller's responsibility to make string (or region) unibyte. | |
48 ;; | |
49 ;; TODO: | |
50 ;; * Rewrite from scratch! | |
51 ;; This version is much faster than Keiichi Suzuki's another sha1.el, | |
52 ;; but it is too dirty. | |
53 | |
54 ;;; Code: | |
55 | |
56 (require 'hex-util) | |
57 | |
58 ;;; | |
59 ;;; external SHA1 function. | |
60 ;;; | |
61 | |
62 (defgroup sha1 nil | |
63 "Elisp interface for SHA1 hash computation." | |
64 :version "22.1" | |
65 :group 'extensions) | |
66 | |
67 (defcustom sha1-maximum-internal-length 500 | |
68 "*Maximum length of message to use Lisp version of SHA1 function. | |
69 If message is longer than this, `sha1-program' is used instead. | |
70 | |
71 If this variable is set to 0, use external program only. | |
72 If this variable is set to nil, use internal function only." | |
73 :type 'integer | |
74 :group 'sha1) | |
75 | |
76 (defcustom sha1-program '("sha1sum") | |
77 "*Name of program to compute SHA1. | |
78 It must be a string \(program name\) or list of strings \(name and its args\)." | |
79 :type '(repeat string) | |
80 :group 'sha1) | |
81 | |
82 (defcustom sha1-use-external (condition-case () | |
83 (executable-find (car sha1-program)) | |
84 (error)) | |
85 "*Use external SHA1 program. | |
86 If this variable is set to nil, use internal function only." | |
87 :type 'boolean | |
88 :group 'sha1) | |
89 | |
90 (defun sha1-string-external (string &optional binary) | |
91 (let (prog args digest default-enable-multibyte-characters) | |
92 (if (consp sha1-program) | |
93 (setq prog (car sha1-program) | |
94 args (cdr sha1-program)) | |
95 (setq prog sha1-program | |
96 args nil)) | |
97 (with-temp-buffer | |
98 (insert string) | |
99 (apply (function call-process-region) | |
100 (point-min)(point-max) | |
101 prog t t nil args) | |
102 ;; SHA1 is 40 bytes long in hexadecimal form. | |
103 (setq digest (buffer-substring (point-min)(+ (point-min) 40)))) | |
104 (if binary | |
105 (decode-hex-string digest) | |
106 digest))) | |
107 | |
108 (defun sha1-region-external (beg end &optional binary) | |
109 (sha1-string-external (buffer-substring-no-properties beg end) binary)) | |
110 | |
111 ;;; | |
112 ;;; internal SHA1 function. | |
113 ;;; | |
114 | |
115 (eval-when-compile | |
116 ;; optional second arg of string-to-number is new in v20. | |
117 (defconst sha1-K0-high 23170) ; (string-to-number "5A82" 16) | |
118 (defconst sha1-K0-low 31129) ; (string-to-number "7999" 16) | |
119 (defconst sha1-K1-high 28377) ; (string-to-number "6ED9" 16) | |
120 (defconst sha1-K1-low 60321) ; (string-to-number "EBA1" 16) | |
121 (defconst sha1-K2-high 36635) ; (string-to-number "8F1B" 16) | |
122 (defconst sha1-K2-low 48348) ; (string-to-number "BCDC" 16) | |
123 (defconst sha1-K3-high 51810) ; (string-to-number "CA62" 16) | |
124 (defconst sha1-K3-low 49622) ; (string-to-number "C1D6" 16) | |
125 | |
126 ;; original definition of sha1-F0. | |
127 ;; (defmacro sha1-F0 (B C D) | |
128 ;; (` (logior (logand (, B) (, C)) | |
129 ;; (logand (lognot (, B)) (, D))))) | |
130 ;; a little optimization from GnuPG/cipher/sha1.c. | |
131 (defmacro sha1-F0 (B C D) | |
132 `(logxor ,D (logand ,B (logxor ,C ,D)))) | |
133 (defmacro sha1-F1 (B C D) | |
134 `(logxor ,B ,C ,D)) | |
135 ;; original definition of sha1-F2. | |
136 ;; (defmacro sha1-F2 (B C D) | |
137 ;; (` (logior (logand (, B) (, C)) | |
138 ;; (logand (, B) (, D)) | |
139 ;; (logand (, C) (, D))))) | |
140 ;; a little optimization from GnuPG/cipher/sha1.c. | |
141 (defmacro sha1-F2 (B C D) | |
142 `(logior (logand ,B ,C) | |
143 (logand ,D (logior ,B ,C)))) | |
144 (defmacro sha1-F3 (B C D) | |
145 `(logxor ,B ,C ,D)) | |
146 | |
147 (defmacro sha1-S1 (W-high W-low) | |
148 `(let ((W-high ,W-high) | |
149 (W-low ,W-low)) | |
150 (setq S1W-high (+ (% (* W-high 2) 65536) | |
151 (/ W-low ,(/ 65536 2)))) | |
152 (setq S1W-low (+ (/ W-high ,(/ 65536 2)) | |
153 (% (* W-low 2) 65536))))) | |
154 (defmacro sha1-S5 (A-high A-low) | |
155 `(progn | |
156 (setq S5A-high (+ (% (* ,A-high 32) 65536) | |
157 (/ ,A-low ,(/ 65536 32)))) | |
158 (setq S5A-low (+ (/ ,A-high ,(/ 65536 32)) | |
159 (% (* ,A-low 32) 65536))))) | |
160 (defmacro sha1-S30 (B-high B-low) | |
161 `(progn | |
162 (setq S30B-high (+ (/ ,B-high 4) | |
163 (* (% ,B-low 4) ,(/ 65536 4)))) | |
164 (setq S30B-low (+ (/ ,B-low 4) | |
165 (* (% ,B-high 4) ,(/ 65536 4)))))) | |
166 | |
167 (defmacro sha1-OP (round) | |
168 `(progn | |
169 (sha1-S5 sha1-A-high sha1-A-low) | |
170 (sha1-S30 sha1-B-high sha1-B-low) | |
171 (setq sha1-A-low (+ (,(intern (format "sha1-F%d" round)) | |
172 sha1-B-low sha1-C-low sha1-D-low) | |
173 sha1-E-low | |
174 ,(symbol-value | |
175 (intern (format "sha1-K%d-low" round))) | |
176 (aref block-low idx) | |
177 (progn | |
178 (setq sha1-E-low sha1-D-low) | |
179 (setq sha1-D-low sha1-C-low) | |
180 (setq sha1-C-low S30B-low) | |
181 (setq sha1-B-low sha1-A-low) | |
182 S5A-low))) | |
183 (setq carry (/ sha1-A-low 65536)) | |
184 (setq sha1-A-low (% sha1-A-low 65536)) | |
185 (setq sha1-A-high (% (+ (,(intern (format "sha1-F%d" round)) | |
186 sha1-B-high sha1-C-high sha1-D-high) | |
187 sha1-E-high | |
188 ,(symbol-value | |
189 (intern (format "sha1-K%d-high" round))) | |
190 (aref block-high idx) | |
191 (progn | |
192 (setq sha1-E-high sha1-D-high) | |
193 (setq sha1-D-high sha1-C-high) | |
194 (setq sha1-C-high S30B-high) | |
195 (setq sha1-B-high sha1-A-high) | |
196 S5A-high) | |
197 carry) | |
198 65536)))) | |
199 | |
200 (defmacro sha1-add-to-H (H X) | |
201 `(progn | |
202 (setq ,(intern (format "sha1-%s-low" H)) | |
203 (+ ,(intern (format "sha1-%s-low" H)) | |
204 ,(intern (format "sha1-%s-low" X)))) | |
205 (setq carry (/ ,(intern (format "sha1-%s-low" H)) 65536)) | |
206 (setq ,(intern (format "sha1-%s-low" H)) | |
207 (% ,(intern (format "sha1-%s-low" H)) 65536)) | |
208 (setq ,(intern (format "sha1-%s-high" H)) | |
209 (% (+ ,(intern (format "sha1-%s-high" H)) | |
210 ,(intern (format "sha1-%s-high" X)) | |
211 carry) | |
212 65536)))) | |
213 ) | |
214 | |
215 ;;; buffers (H0 H1 H2 H3 H4). | |
216 (defvar sha1-H0-high) | |
217 (defvar sha1-H0-low) | |
218 (defvar sha1-H1-high) | |
219 (defvar sha1-H1-low) | |
220 (defvar sha1-H2-high) | |
221 (defvar sha1-H2-low) | |
222 (defvar sha1-H3-high) | |
223 (defvar sha1-H3-low) | |
224 (defvar sha1-H4-high) | |
225 (defvar sha1-H4-low) | |
226 | |
227 (defun sha1-block (block-high block-low) | |
228 (let (;; step (c) --- initialize buffers (A B C D E). | |
229 (sha1-A-high sha1-H0-high) (sha1-A-low sha1-H0-low) | |
230 (sha1-B-high sha1-H1-high) (sha1-B-low sha1-H1-low) | |
231 (sha1-C-high sha1-H2-high) (sha1-C-low sha1-H2-low) | |
232 (sha1-D-high sha1-H3-high) (sha1-D-low sha1-H3-low) | |
233 (sha1-E-high sha1-H4-high) (sha1-E-low sha1-H4-low) | |
234 (idx 16)) | |
235 ;; step (b). | |
236 (let (;; temporary variables used in sha1-S1 macro. | |
237 S1W-high S1W-low) | |
238 (while (< idx 80) | |
239 (sha1-S1 (logxor (aref block-high (- idx 3)) | |
240 (aref block-high (- idx 8)) | |
241 (aref block-high (- idx 14)) | |
242 (aref block-high (- idx 16))) | |
243 (logxor (aref block-low (- idx 3)) | |
244 (aref block-low (- idx 8)) | |
245 (aref block-low (- idx 14)) | |
246 (aref block-low (- idx 16)))) | |
247 (aset block-high idx S1W-high) | |
248 (aset block-low idx S1W-low) | |
249 (setq idx (1+ idx)))) | |
250 ;; step (d). | |
251 (setq idx 0) | |
252 (let (;; temporary variables used in sha1-OP macro. | |
253 S5A-high S5A-low S30B-high S30B-low carry) | |
254 (while (< idx 20) (sha1-OP 0) (setq idx (1+ idx))) | |
255 (while (< idx 40) (sha1-OP 1) (setq idx (1+ idx))) | |
256 (while (< idx 60) (sha1-OP 2) (setq idx (1+ idx))) | |
257 (while (< idx 80) (sha1-OP 3) (setq idx (1+ idx)))) | |
258 ;; step (e). | |
259 (let (;; temporary variables used in sha1-add-to-H macro. | |
260 carry) | |
261 (sha1-add-to-H H0 A) | |
262 (sha1-add-to-H H1 B) | |
263 (sha1-add-to-H H2 C) | |
264 (sha1-add-to-H H3 D) | |
265 (sha1-add-to-H H4 E)))) | |
266 | |
267 (defun sha1-binary (string) | |
268 "Return the SHA1 of STRING in binary form." | |
269 (let (;; prepare buffers for a block. byte-length of block is 64. | |
270 ;; input block is split into two vectors. | |
271 ;; | |
272 ;; input block: 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F ... | |
273 ;; block-high: +-0-+ +-1-+ +-2-+ +-3-+ | |
274 ;; block-low: +-0-+ +-1-+ +-2-+ +-3-+ | |
275 ;; | |
276 ;; length of each vector is 80, and elements of each vector are | |
277 ;; 16bit integers. elements 0x10-0x4F of each vector are | |
278 ;; assigned later in `sha1-block'. | |
279 (block-high (eval-when-compile (make-vector 80 nil))) | |
280 (block-low (eval-when-compile (make-vector 80 nil)))) | |
281 (unwind-protect | |
282 (let* (;; byte-length of input string. | |
283 (len (length string)) | |
284 (lim (* (/ len 64) 64)) | |
285 (rem (% len 4)) | |
286 (idx 0)(pos 0)) | |
287 ;; initialize buffers (H0 H1 H2 H3 H4). | |
288 (setq sha1-H0-high 26437 ; (string-to-number "6745" 16) | |
289 sha1-H0-low 8961 ; (string-to-number "2301" 16) | |
290 sha1-H1-high 61389 ; (string-to-number "EFCD" 16) | |
291 sha1-H1-low 43913 ; (string-to-number "AB89" 16) | |
292 sha1-H2-high 39098 ; (string-to-number "98BA" 16) | |
293 sha1-H2-low 56574 ; (string-to-number "DCFE" 16) | |
294 sha1-H3-high 4146 ; (string-to-number "1032" 16) | |
295 sha1-H3-low 21622 ; (string-to-number "5476" 16) | |
296 sha1-H4-high 50130 ; (string-to-number "C3D2" 16) | |
297 sha1-H4-low 57840) ; (string-to-number "E1F0" 16) | |
298 ;; loop for each 64 bytes block. | |
299 (while (< pos lim) | |
300 ;; step (a). | |
301 (setq idx 0) | |
302 (while (< idx 16) | |
303 (aset block-high idx (+ (* (aref string pos) 256) | |
304 (aref string (1+ pos)))) | |
305 (setq pos (+ pos 2)) | |
306 (aset block-low idx (+ (* (aref string pos) 256) | |
307 (aref string (1+ pos)))) | |
308 (setq pos (+ pos 2)) | |
309 (setq idx (1+ idx))) | |
310 (sha1-block block-high block-low)) | |
311 ;; last block. | |
312 (if (prog1 | |
313 (< (- len lim) 56) | |
314 (setq lim (- len rem)) | |
315 (setq idx 0) | |
316 (while (< pos lim) | |
317 (aset block-high idx (+ (* (aref string pos) 256) | |
318 (aref string (1+ pos)))) | |
319 (setq pos (+ pos 2)) | |
320 (aset block-low idx (+ (* (aref string pos) 256) | |
321 (aref string (1+ pos)))) | |
322 (setq pos (+ pos 2)) | |
323 (setq idx (1+ idx))) | |
324 ;; this is the last (at most) 32bit word. | |
325 (cond | |
326 ((= rem 3) | |
327 (aset block-high idx (+ (* (aref string pos) 256) | |
328 (aref string (1+ pos)))) | |
329 (setq pos (+ pos 2)) | |
330 (aset block-low idx (+ (* (aref string pos) 256) | |
331 128))) | |
332 ((= rem 2) | |
333 (aset block-high idx (+ (* (aref string pos) 256) | |
334 (aref string (1+ pos)))) | |
335 (aset block-low idx 32768)) | |
336 ((= rem 1) | |
337 (aset block-high idx (+ (* (aref string pos) 256) | |
338 128)) | |
339 (aset block-low idx 0)) | |
340 (t ;; (= rem 0) | |
341 (aset block-high idx 32768) | |
342 (aset block-low idx 0))) | |
343 (setq idx (1+ idx)) | |
344 (while (< idx 16) | |
345 (aset block-high idx 0) | |
346 (aset block-low idx 0) | |
347 (setq idx (1+ idx)))) | |
348 ;; last block has enough room to write the length of string. | |
349 (progn | |
350 ;; write bit length of string to last 4 bytes of the block. | |
351 (aset block-low 15 (* (% len 8192) 8)) | |
352 (setq len (/ len 8192)) | |
353 (aset block-high 15 (% len 65536)) | |
354 ;; XXX: It is not practical to compute SHA1 of | |
355 ;; such a huge message on emacs. | |
356 ;; (setq len (/ len 65536)) ; for 64bit emacs. | |
357 ;; (aset block-low 14 (% len 65536)) | |
358 ;; (aset block-high 14 (/ len 65536)) | |
359 (sha1-block block-high block-low)) | |
360 ;; need one more block. | |
361 (sha1-block block-high block-low) | |
362 (fillarray block-high 0) | |
363 (fillarray block-low 0) | |
364 ;; write bit length of string to last 4 bytes of the block. | |
365 (aset block-low 15 (* (% len 8192) 8)) | |
366 (setq len (/ len 8192)) | |
367 (aset block-high 15 (% len 65536)) | |
368 ;; XXX: It is not practical to compute SHA1 of | |
369 ;; such a huge message on emacs. | |
370 ;; (setq len (/ len 65536)) ; for 64bit emacs. | |
371 ;; (aset block-low 14 (% len 65536)) | |
372 ;; (aset block-high 14 (/ len 65536)) | |
373 (sha1-block block-high block-low)) | |
374 ;; make output string (in binary form). | |
375 (let ((result (make-string 20 0))) | |
376 (aset result 0 (/ sha1-H0-high 256)) | |
377 (aset result 1 (% sha1-H0-high 256)) | |
378 (aset result 2 (/ sha1-H0-low 256)) | |
379 (aset result 3 (% sha1-H0-low 256)) | |
380 (aset result 4 (/ sha1-H1-high 256)) | |
381 (aset result 5 (% sha1-H1-high 256)) | |
382 (aset result 6 (/ sha1-H1-low 256)) | |
383 (aset result 7 (% sha1-H1-low 256)) | |
384 (aset result 8 (/ sha1-H2-high 256)) | |
385 (aset result 9 (% sha1-H2-high 256)) | |
386 (aset result 10 (/ sha1-H2-low 256)) | |
387 (aset result 11 (% sha1-H2-low 256)) | |
388 (aset result 12 (/ sha1-H3-high 256)) | |
389 (aset result 13 (% sha1-H3-high 256)) | |
390 (aset result 14 (/ sha1-H3-low 256)) | |
391 (aset result 15 (% sha1-H3-low 256)) | |
392 (aset result 16 (/ sha1-H4-high 256)) | |
393 (aset result 17 (% sha1-H4-high 256)) | |
394 (aset result 18 (/ sha1-H4-low 256)) | |
395 (aset result 19 (% sha1-H4-low 256)) | |
396 result)) | |
397 ;; do not leave a copy of input string. | |
398 (fillarray block-high nil) | |
399 (fillarray block-low nil)))) | |
400 | |
401 (defun sha1-string-internal (string &optional binary) | |
402 (if binary | |
403 (sha1-binary string) | |
404 (encode-hex-string (sha1-binary string)))) | |
405 | |
406 (defun sha1-region-internal (beg end &optional binary) | |
407 (sha1-string-internal (buffer-substring-no-properties beg end) binary)) | |
408 | |
409 ;;; | |
410 ;;; application interface. | |
411 ;;; | |
412 | |
413 (defun sha1-region (beg end &optional binary) | |
414 (if (and sha1-use-external | |
415 sha1-maximum-internal-length | |
416 (> (abs (- end beg)) sha1-maximum-internal-length)) | |
417 (sha1-region-external beg end binary) | |
418 (sha1-region-internal beg end binary))) | |
419 | |
420 (defun sha1-string (string &optional binary) | |
421 (if (and sha1-use-external | |
422 sha1-maximum-internal-length | |
423 (> (length string) sha1-maximum-internal-length)) | |
424 (sha1-string-external string binary) | |
425 (sha1-string-internal string binary))) | |
426 | |
427 ;;;###autoload | |
428 (defun sha1 (object &optional beg end binary) | |
429 "Return the SHA1 (Secure Hash Algorithm) of an object. | |
430 OBJECT is either a string or a buffer. | |
431 Optional arguments BEG and END denote buffer positions for computing the | |
432 hash of a portion of OBJECT. | |
433 If BINARY is non-nil, return a string in binary form." | |
434 (if (stringp object) | |
435 (sha1-string object binary) | |
436 (with-current-buffer object | |
437 (sha1-region (or beg (point-min)) (or end (point-max)) binary)))) | |
438 | |
439 (provide 'sha1) | |
440 | |
441 ;; arch-tag: c0f9abd0-ffc1-4557-aac6-ece7f2d4c901 | |
442 ;;; sha1.el ends here |