;;; ;;; digest - abstract base class for message digest algorithms ;;; ;;; 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. ;;; ;; An abstract base- and meta-class of message digest algorithms. ;; The concrete implementation is given in modules such as ;; rfc.md5 and rfc.sha. (define-module util.digest (use gauche.uvector) (use rfc.base64) (export digest-update! digest-final! digest digest-to digest-message-to ;; Obsoleted API digest-string digest-hexify) ) (select-module util.digest) (autoload gauche.vport open-input-uvector) ;; API for digest algorithms ;; Actual digest algorithms such as SHA should subclass ;; , and implement digest-update! ;; and digest-final!, or digest. (define-class () ;; Block size (in bytes) used in HMAC, determined by each algorithm. ;; Older algorithms uses 64, while SHA-384/512 uses 128. ((hmac-block-size :init-keyword :hmac-block-size :init-value 64))) (define-class () () :metaclass ) (define-method digest-update! ((self ) data) #f) (define-method digest-final! ((self )) #f) (define-method digest ((digester )) #f) ;; User API (define-method digest-to ((target ) (digester )) (digest digester)) (define-method digest-to ((target ) (digester )) (string->u8vector (digest digester))) ;; Special targets: ;; base64 ;; base64url ;; base64url-nopad ;; base32 ;; base32hex ;; base16 ;; hex (define-method digest-to ((target ) (digester )) (define encoder (ecase target [(base64) base64-encode-message] [(base64url) (cut base64-encode-message <> :url-safe #t)] [(base64url-nopad) (cut base64-encode-message <> :url-safe #t :omit-padding #t)] [(base32) base32-encode-message] [(base32hex) base32hex-encode-message] [(base16) base16-encode-message] [(hex) (cut base16-encode-message <> :lowercase #t)])) (encoder (digest digester))) ;; User API (define-method digest-message-to (target (digester ) message) (etypecase message [ (with-input-from-string message (cut digest-to target digester))] [ (with-input-from-port (open-input-uvector message) (cut digest-to target digester))])) ;; OBSOLETED ;; Use digest-message-to. (define-method digest-string ((digester ) string) (digest-message-to digester string)) ;; OBSOLETED ;; Use base16-encode-message, or digest-message-to with ;; predefined encoder targets. (define (digest-hexify data) (base16-encode-message data :lowercase #t))