Fix typo.
[elisp/flim.git] / digest-md5.el
1 ;;; digest-md5.el --- Compute DIGEST-MD5.
2
3 ;; Copyright (C) 1999 Kenichi OKADA
4
5 ;; Author: Kenichi OKADA <okada@opaopa.org>
6 ;; Keywords: DIGEST-MD5, HMAC-MD5, SASL, IMAP, POP, ACAP
7
8 ;; This file is part of FLIM (Faithful Library about Internet Message).
9
10 ;; This program is free software; you can redistribute it and/or
11 ;; modify it under the terms of the GNU General Public License as
12 ;; published by the Free Software Foundation; either version 2, or
13 ;; (at your option) any later version.
14
15 ;; This program 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 this program; see the file COPYING.  If not, write to
22 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; NOW BUILDING.
28
29 ;; This program is implemented from draft-leach-digest-sasl-05.txt.
30 ;;
31 ;; It is caller's responsibility to base64-decode challenges and
32 ;; base64-encode responses in IMAP4 AUTHENTICATE command.
33 ;;
34 ;; Passphrase should be longer than 16 bytes. (See RFC 2195)
35
36 ;; Examples.
37 ;;
38 ;; (digest-md5-digest-response "chris" "elwood.innosoft.com"
39 ;;                        "OA6MG9tEQGm2hh" "OA6MHXh6VqTrRk"
40 ;;                        "imap/elwood.innosoft.com"
41 ;;                        "d388dad90d4bbd760a152321f2143af7"
42 ;;                        1 "auth" nil "utf-8")
43 ;; => "charset=utf-8,username=\"chris\",realm=\"elwood.innosoft.com\",nonce=\"OA6MG9tEQGm2hh\",nc=00000001,cnonce=\"OA6MHXh6VqTrRk\",digest-uri=\"imap/elwood.innosoft.com\",response=d388dad90d4bbd760a152321f2143af7,qop=auth"
44 ;;
45
46 ;;; Code:
47
48 (require 'hmac-md5)
49 (require 'unique-id)
50
51 (defvar digest-md5-parse-digest-challenge-syntax-table
52   (let ((table (make-syntax-table)))
53     (modify-syntax-entry ?= "." table)
54     (modify-syntax-entry ?, "." table)
55     table)
56   "A syntax table for parsing sgml attributes.")
57
58 (defun digest-md5-parse-digest-challenge (digest-challenge)
59   ;; return a property list of 
60   ;; (realm nonce qop-options stale maxbuf charset 
61   ;; algorithm cipher-opts auth-param).
62   (with-temp-buffer
63     (set-syntax-table digest-md5-parse-digest-challenge-syntax-table)
64     (insert digest-challenge)
65     (goto-char (point-min))
66     (insert "(")
67     (while (progn (forward-sexp) (not (eobp)))
68       (delete-char 1)
69       (insert " "))
70     (insert ")")
71     (condition-case nil
72         (read (point-min-marker))
73       (end-of-file
74        (error "Parse error in digest-challenge.")))))
75
76 (defun digest-md5-digest-uri (serv-type host &optional serv-name)
77   (concat serv-type "/" host
78           (if (and serv-name
79                    (null (string= host serv-name)))
80               (concat "/" serv-name))))
81
82 (defun digest-md5-cnonce ()
83   ;; It is RECOMMENDED that it 
84   ;; contain at least 64 bits of entropy.
85   (concat (unique-id-m "") (unique-id-m "")))
86
87 (defun digest-md5-digest-response (username 
88                                    realm nonce cnonce
89                                    digest-uri response 
90                                    &optional nonce-count qop 
91                                    maxbuf charset cipher authzid)
92   (concat
93    (if charset
94        (concat "charset=" charset ","))
95    "username=\"" username "\""
96    ",realm=\"" realm "\""
97    ",nonce=\"" nonce "\""
98    (format ",nc=%08x"
99            (or nonce-count 1))
100    ",cnonce=\"" cnonce "\""
101    ",digest-uri=\"" digest-uri "\""
102    ",response=" response
103    (if qop
104        (concat ",qop=" qop))
105    (if maxbuf
106        (concat ",maxbuf=" maxbuf))
107    (if cipher
108        (concat ",cipher=" cipher))
109    (if authzid
110        (concat ",authzid=\"" authzid "\""))))
111
112   
113 (provide 'digest-md5)
114
115 ;;; digest-md5.el ends here