;;; ;;; hmac - HMAC keyed-hashing ;;; ;;; Copyright (c) 2002-2003 Kimura Fuyuki, All rights reserved. ;;; ;;; Redistribution and use in source and binary forms, with or without ;;; modification, are permitted provided that the following conditions ;;; are met: ;;; ;;; 1. Redistributions of source code must retain the above copyright ;;; notice, this list of conditions and the following disclaimer. ;;; ;;; 2. Redistributions in binary form must reproduce the above copyright ;;; notice, this list of conditions and the following disclaimer in the ;;; documentation and/or other materials provided with the distribution. ;;; ;;; 3. Neither the name of the authors nor the names of its contributors ;;; may be used to endorse or promote products derived from this ;;; software without specific prior written permission. ;;; ;;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ;;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT ;;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ;;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT ;;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, ;;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;;; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR ;;; PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF ;;; LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING ;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;;; ;;; RFC 2104 HMAC: Keyed-Hashing for Message Authentication (define-module rfc.hmac (use util.digest) (use gauche.sequence) (use gauche.uvector) (use gauche.mop.typed-slot) (export hmac-to hmac-message-to hmac-message hmac-verify ;; Low-level API make-hmac hmac-update! hmac-final! ;; Deprecated hmac-digest hmac-digest-string)) (select-module rfc.hmac) (autoload gauche.vport open-input-uvector) ;; User API (define (hmac-to target algorithm key) (let1 hmac (make-hmac algorithm key) (generator-for-each (cut hmac-update! hmac <>) (cut read-block 4096)) (hmac-final! hmac target))) ;; User API (define (hmac-message-to target algorithm key message) (define (thunk) (hmac-to target algorithm key)) (etypecase message [ (with-input-from-string message thunk)] [ (with-input-from-port (open-input-uvector message) thunk)])) ;; User API (define (hmac-message algorithm key message) (hmac-message-to algorithm key message)) ;; User API (define (hmac-verify algorithm given-digest key message) (assume-type given-digest ) ;; We compare two u8vectors in constant time (let* ([computed-digest (hmac-message algorithm key message)] [given-len (u8vector-length given-digest)] [computed-len (u8vector-length computed-digest)] [len (min given-len computed-len)]) (let loop ([i 0] [ok #t]) (if (= i len) (and ok (= given-len computed-len)) (loop (+ i 1) (and (= (u8vector-ref given-digest i) (u8vector-ref computed-digest i)) ok)))))) ;; Low-level API (define-class () ;; All slots are private ((padded-key :immutable #t :init-keyword :padded-key) (hasher :immutable #t :init-keyword :hasher))) ;; TRANSIENT: ;; We don't need initialize method for the new API. This is only ;; to catch old code that calls (make :key ...). ;; We'd drop this after a few releases. (define-method initialize ((hmac ) initargs) (next-method) (let-keywords initargs ((padded-key #f) (hasher #f) (key #f)) (when key (warn "Instantiating directly is obsoleted.\ Use make-hmac instead.\n") ;; A very awkward way to keep backward compatibility. ;; NB: The 'hasher' slot of dummy is not the same as the ;; hasher argument passed to make-hmac. (let1 dummy (make-hmac hasher key) (set! (~ hmac'padded-key) (~ dummy'padded-key)) (set! (~ hmac'hasher) (~ dummy'hasher)))))) (define (make-hmac algorithm key :optional (block-size #f)) (assume-type key ( )) (assume-type algorithm ) (let* ([block-size (or block-size (~ algorithm'hmac-block-size))] [key-v (if (string? key) (string->u8vector key) key)] [key-v (if (> (u8vector-length key-v) block-size) (digest-message-to algorithm key-v) key-v)] [key-v ($ u8vector-append key-v $ make-u8vector (- block-size (u8vector-length key-v)) 0)]) (rlet1 hmac (make :padded-key key-v :hasher (make algorithm)) (let1 ipad (u8vector->string (u8vector-xor key-v #x36)) (digest-update! (~ hmac'hasher) ipad))))) (define-method hmac-update! ((hmac ) data) (digest-update! (~ hmac'hasher) data)) (define-method hmac-final! ((hmac ) :optional (target )) (let* ([opad (u8vector->string (u8vector-xor (~ hmac'padded-key) #x5c))] [inner (digest-final! (~ hmac'hasher))] [outer (digest-message-to target (class-of (~ hmac'hasher)) (string-append opad inner))]) outer)) ;; Deprecated (define (hmac-digest :key key hasher) (hmac-to hasher key)) ;; Deprecated (define (hmac-digest-string string . args) (with-input-from-string string (cut apply hmac-digest args)))