lisp/gnus/rfc2104.el

   1 ;;; rfc2104.el --- RFC2104 Hashed Message Authentication Codes
   2
   3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
   7 ;; Keywords: mail
   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 is a quick'n'dirty, low performance, implementation of RFC2104.
  29 ;;;
  30 ;;; Example:
  31 ;;;
  32 ;;; (require 'md5)
  33 ;;; (rfc2104-hash 'md5 64 16 "Jefe" "what do ya want for nothing?")
  34 ;;; "750c783e6ab0b503eaa86e310a5db738"
  35 ;;;
  36 ;;; (require 'sha-1)
  37 ;;; (rfc2104-hash 'sha1-encode 64 20 "Jefe" "what do ya want for nothing?")
  38 ;;; "effcdf6ae5eb2fa2d27416d5f184df9c259a7c79"
  39 ;;;
  40 ;;; 64 is block length of hash function (64 for MD5 and SHA), 16 is
  41 ;;; resulting hash length (16 for MD5, 20 for SHA).
  42 ;;;
  43 ;;; Tested with Emacs 20.2 and XEmacs 20.3.
  44 ;;;
  45 ;;; Test case reference: RFC 2202.
  46
  47 ;;; Release history:
  48 ;;;
  49 ;;; 1998-08-16  initial release posted to gnu.emacs.sources
  50 ;;; 1998-08-17  use append instead of char-list-to-string
  51 ;;; 1998-08-26  don't require hexl
  52 ;;; 1998-09-25  renamed from hmac.el to rfc2104.el, also renamed functions
  53 ;;; 1999-10-23  included in pgnus
  54 ;;; 2000-08-15  `rfc2104-hexstring-to-bitstring'
  55 ;;; 2000-05-12  added sha-1 example, added test case reference
  56 ;;; 2003-11-13  change rfc2104-hexstring-to-bitstring to ...-byte-list
  57
  58 ;;; Code:
  59
  60 (eval-when-compile (require 'cl))
  61
  62 ;; Magic character for inner HMAC round. 0x36 == 54 == '6'
  63 (defconst rfc2104-ipad ?\x36)
  64
  65 ;; Magic character for outer HMAC round. 0x5C == 92 == '\'
  66 (defconst rfc2104-opad ?\x5C)
  67
  68 ;; Not so magic character for padding the key. 0x00
  69 (defconst rfc2104-zero ?\x00)
  70
  71 ;; Alist for converting hex to decimal.
  72 (defconst rfc2104-hex-alist
  73   '((?0 . 0)          (?a . 10)       (?A . 10)
  74     (?1 . 1)          (?b . 11)       (?B . 11)
  75     (?2 . 2)          (?c . 12)       (?C . 12)
  76     (?3 . 3)          (?d . 13)       (?D . 13)
  77     (?4 . 4)          (?e . 14)       (?E . 14)
  78     (?5 . 5)          (?f . 15)       (?F . 15)
  79     (?6 . 6)
  80     (?7 . 7)
  81     (?8 . 8)
  82     (?9 . 9)))
  83
  84 (defun rfc2104-hex-to-int (str)
  85   (if str
  86       (if (listp str)
  87           (+ (* 16 (rfc2104-hex-to-int (cdr str)))
  88              (cdr (assoc (car str) rfc2104-hex-alist)))
  89         (rfc2104-hex-to-int (reverse (append str nil))))
  90     0))
  91
  92 (defun rfc2104-hexstring-to-byte-list (str)
  93   (let (out)
  94     (while (< 0 (length str))
  95       (push (rfc2104-hex-to-int (substring str -2)) out)
  96       (setq str (substring str 0 -2)))
  97     out))
  98
  99 (defun rfc2104-hash (hash block-length hash-length key text)
 100   (let* (;; if key is longer than B, reset it to HASH(key)
 101          (key (if (> (length key) block-length)
 102                   (funcall hash key) key))
 103          (k_ipad (append key nil))
 104          (k_opad (append key nil)))
 105     ;; zero pad k_ipad/k_opad
 106     (while (< (length k_ipad) block-length)
 107       (setq k_ipad (append k_ipad (list rfc2104-zero))))
 108     (while (< (length k_opad) block-length)
 109       (setq k_opad (append k_opad (list rfc2104-zero))))
 110     ;; XOR key with ipad/opad into k_ipad/k_opad
 111     (setq k_ipad (mapcar (lambda (c) (logxor c rfc2104-ipad)) k_ipad))
 112     (setq k_opad (mapcar (lambda (c) (logxor c rfc2104-opad)) k_opad))
 113     ;; perform outer hash
 114     (funcall hash
 115              (encode-coding-string
 116               (concat k_opad (rfc2104-hexstring-to-byte-list
 117                               ;; perform inner hash
 118                               (funcall hash (concat k_ipad text))))
 119               'iso-latin-1))))
 120
 121 (provide 'rfc2104)
 122
 123 ;; arch-tag: cf671d5c-a45f-4a09-815e-704e59e43950
 124 ;;; rfc2104.el ends here