chickadee » message-digest-utils

message-digest-utils

TOC »

Documentation

Message Digest provides support for message digest primitives. A message-digest is a function taking some input source and returning a fixed-length hash.

For best results the source object(s) to be accumulated into the digest should be something easily treated as a bytevector.

Message Digest Byte Vector

Digest routines for string & blob.

Usage

(import message-digest-byte-vector)

message-digest-update-blob

message-digest-update-blob DIGEST BLOB #!optional START ENDprocedure

Update the DIGEST with a BLOB, optionally sliced by START END.

message-digest-update-string

message-digest-update-string DIGEST STRING #!optional START ENDprocedure

Update the DIGEST with a STRING, optionally sliced by START END.

message-digest-string

message-digest-string PRIM STRING #!optional RESULT-FORM START ENDprocedure

Returns the RESULT for the digest algorithm PRIM applied to STRING, optionally sliced by START END, in the RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

message-digest-blob

message-digest-blob PRIM BLOB #!optional RESULT-FORM START ENDprocedure

Returns the result for the digest algorithm PRIM applied to BLOB, optionally sliced by START END, in the RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

message-digest-string!

message-digest-string! PRIM STRING BUFFER #!optional START ENDprocedure

Returns the RESULT for the digest algorithm PRIM applied to STRING, optionally sliced by START END, in the BUFFER.

message-digest-blob!

message-digest-blob! PRIM BLOB BUFFER #!optional START ENDprocedure

Returns the result for the digest algorithm PRIM applied to BLOB, optionally sliced by START END, in the {BUFFER}.

message-digest-update-substring (DEPRECATED)

message-digest-update-substring DIGEST STRING START ENDprocedure

Update the DIGEST with a substring STRING START END.

Message Digest Int

Provides digest update operations for character and integer datatypes.

Usage

(import message-digest-int)

message-digest-update-char-u8

message-digest-update-char-u8 DIGEST CHARprocedure

Update the DIGEST with the low-order 8-bits of a character CHAR.

message-digest-update-char

message-digest-update-char DIGEST CHAR #!optional ENDIANprocedure

Update the DIGEST with a the character CHAR 32-bit integer value treated as ENDIAN.

ENDIAN default is (machine-byte-order).

message-digest-update-char-be

message-digest-update-char-be DIGEST CHARprocedure

Update the DIGEST with a the character CHAR 32-bit integer value treated as big-endian.

message-digest-update-char-le

message-digest-update-char-le DIGEST CHARprocedure

Update the DIGEST with a the character CHAR 32-bit integer value treated as little-endian.

message-digest-update-u8

message-digest-update-u8 DIGEST U8procedure

Update the DIGEST with an 8-bit integer U8.

message-digest-update-u16

message-digest-update-u16 DIGEST U16 #!optional ENDIANprocedure

Update the DIGEST with a 16-bit integer U16 treated as ENDIAN.

ENDIAN default is (machine-byte-order).

message-digest-update-u16-be

message-digest-update-u16-be DIGEST U16procedure

Update the DIGEST with a 16-bit integer U16 treated as big-endian.

message-digest-update-u16-le

message-digest-update-u16-le DIGEST U16procedure

Update the DIGEST with a 16-bit integer U16 treated as little-endian.

message-digest-update-u32

message-digest-update-u32 DIGEST U32 #!optional ENDIANprocedure

Update the DIGEST with a 32-bit integer U32 treated as ENDIAN.

ENDIAN default is (machine-byte-order).

message-digest-update-u32-be

message-digest-update-u32-be DIGEST U32procedure

Update the DIGEST with a 32-bit integer U32 treated as big-endian.

message-digest-update-u32-le

message-digest-update-u32-le DIGEST U32procedure

Update the DIGEST with a 32-bit integer U32 treated as little-endian.

message-digest-update-u64

message-digest-update-u64 DIGEST U64 #!optional ENDIANprocedure

Update the DIGEST with a 64-bit integer U64 treated as ENDIAN.

ENDIAN default is (machine-byte-order).

message-digest-update-u64-be

message-digest-update-u64-be DIGEST U64procedure

Update the DIGEST with a 64-bit integer U64 treated as big-endian.

message-digest-update-u64-le

message-digest-update-u64-le DIGEST U64procedure

Update the DIGEST with a 64-bit integer U64 treated as little-endian.

Message Digest Update Item

Provides digest update operations for Scheme objects.

Usage

(import message-digest-update-item)

message-digest-update-file

message-digest-update-file DIGEST FILENAMEprocedure

Update the DIGEST with the contents of file FILENAME.

message-digest-update-procedure

message-digest-update-procedure DIGEST THUNKprocedure

Update the DIGEST with a THUNK until it returns #f.

THUNK is a (-> byte-source).

message-digest-update-port

message-digest-update-port DIGEST INPUT-PORTprocedure

Update the DIGEST with byte-source from an INPUT-PORT until #!eof encountered.

Uses the message-digest-chunk-read-maker to create a reader for the port.

message-digest-update-object

message-digest-update-object DIGEST SOURCE #!optional START ENDprocedure

Update the DIGEST with some SOURCE.

SOURCE maybe

input-port
as in message-digest-update-port
procedure
as in message-digest-update-procedure
string
blob
srfi-4-vector
*
((message-digest-chunk-converter) SOURCE) -> byte-source.

If START END supplied, and possible, the byte-source is sliced.

Message Digest Item

Provides digest operations for whole Scheme objects.

Usage

(import message-digest-item)

message-digest-object

message-digest-object PRIM SOURCE #!optional RESULT-FORM START ENDprocedure

Returns the result for the digest algorithm PRIM applied to SOURCE, optionally sliced by START END, in the RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

message-digest-file

message-digest-file PRIM FILENAME #!optional RESULT-FORMprocedure

Returns the result for the digest algorithm PRIM applied to the file FILENAME in the RESULT-FORM. Reads until #!eof encountered.

RESULT-FORM default is (message-digest-result-form).

message-digest-port

message-digest-port PRIM INPUT-PORT #!optional RESULT-FORMprocedure

Returns the result for the digest algorithm PRIM applied to INPUT-PORT in the RESULT-FORM. Reads until #!eof encountered.

RESULT-FORM default is (message-digest-result-form).

message-digest-object!

message-digest-object! PRIM SOURCE BUFFER #!optional START ENDprocedure

Returns the result for the digest algorithm PRIM applied to SOURCE, optionally sliced by START END, in the BUFFER.

message-digest-file!

message-digest-file! PRIM FILENAME BUFFERprocedure

Returns the result for the digest algorithm PRIM applied to the file FILENAME in the BUFFER. Reads until #!eof encountered.

message-digest-port!

message-digest-port! PRIM INPUT-PORT BUFFERprocedure

Returns the result for the digest algorithm PRIM applied to INPUT-PORT in the BUFFER. Reads until #!eof encountered.

Message Digest SRFI 4

Provides digest operations for SRFI-4 packed-vectors.

Usage

(import message-digest-srfi-4)

message-digest-update-u8vector

message-digest-update-u8vector DIGEST U8VECTOR #!optional START ENDprocedure

Update the DIGEST with a U8VECTOR, optionally sliced by START END.

message-digest-u8vector

message-digest-u8vector PRIM U8VECTOR #!optional RESULT-FORM START ENDprocedure

Returns the result for the digest algorithm PRIM applied to U8VECTOR, optionally sliced by START END, in the RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

message-digest-u8vector!

message-digest-u8vector! PRIM U8VECTOR BUFFER #!optional START ENDprocedure

Returns the result for the digest algorithm PRIM applied to U8VECTOR, optionally sliced by START END, in the BUFFER.

message-digest-update-subu8vector (DEPRECATED)

message-digest-update-subu8vector DIGEST U8VECTOR START ENDprocedure

Update the DIGEST with a subvector U8VECTOR START END.

message-digest-update-bytevector (DEPRECATED)

message-digest-update-bytevector DIGEST BYTEVECTOR #!optional LENGTHprocedure

Update the DIGEST with the BYTEVECTOR, a blob, string, or srfi-4-vector.

The LENGTH is the byte count. Default is the size in bytes of the BYTEVECTOR.

Message Digest Port

Provides a port abstraction for a message-digest-primitive.

Usage

(import message-digest-port)

Common Argument Definitions

PORT is a digest-output-port.

digest-output-port

digest-output-port? OBJprocedure
check-digest-output-port LOC OBJ #!optional NAMprocedure
error-digest-output-port LOC OBJ #!optional NAMprocedure
digest-output-port-name PORTprocedure

open-output-digest

open-output-digest PRIMprocedure

Returns a message digest output port for the supplied algorithm PRIM.

The initialization phase.

get-output-digest

get-output-digest PORT #!optional RESULT-FORMprocedure

Closes the PORT and returns the result as a RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

The finalization phase.

call-with-output-digest

call-with-output-digest PRIM PROC #!optional RESULT-FORMprocedure

Returns the result of the call of PROC with an open-output-digest for PRIM in the RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

with-output-to-digest

with-output-to-digest PRIM THUNK #!optional RESULT-FORMprocedure

Invoke the procedure THUNK with (current-output-port) bound to a digest-output-port and return in the RESULT-FORM.

RESULT-FORM default is (message-digest-result-form).

Message Digest Chunk

An inchoate Chunking API.

Usage

(import message-digest-chunk)

message-digest-chunk-port-read-maker

message-digest-chunk-port-read-maker #!optional CTORparameter

Supplies the procedure used to create an input procedure.

CTOR
(PORT #!optional SIZE) -> (-> byte-source)
PORT
source open input port
SIZE
chunk size, default (message-digest-chunk-size)

The default CTOR returns a reader from PORT in SIZE bytes.

message-digest-chunk-fileno-read-maker

message-digest-chunk-fileno-read-maker #!optional CTORparameter

Supplies the procedure used to create an input procedure.

CTOR
(FD #!optional TOTAL SIZE) -> (-> byte-source)
FD
source open fileno
TOTAL
total size, default (file-size FD))
SIZE
chunk size, default (message-digest-chunk-size)

The default CTOR returns a reader conditioned on memory-mapped-file support.

message-digest-chunk-size

message-digest-chunk-size #!optional SIZEparameter

The number of bytes to read from a binary-stream during the message-digest update phase. Used by the default message-digest-chunk-read-maker.

SIZE
positive-integer, default 1024

message-digest-chunk-converter

message-digest-chunk-converter #!optional CONVparameter

The procedure used to translate an arbitrary object into something suitable for an UPDATE procedure. See make-message-digest-primitive.

CONV
(* -> byte-source) or #f, default #f

Should the CONV be #f or return #f then no translation is attempted.

Examples

Uses the message-digest port abstraction to get an MD5 digest of a string:

(import message-digest-port md5) ; Or sha1, or sha2, ...

(call-with-output-digest (md5-primitive) (cut display "foo" <>))
;=> "acbd18db4cc2f85cedef654fccc4a4d8"

Bugs and Limitations

Notes

Requirements

check-errors blob-utils string-utils

Author

Kon Lovett

Version history

4.1.2
.
4.0.0
CHICKEN 5 release.

License

 Copyright (C) 2018 Kon Lovett.  All rights reserved.
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the Software),
 to deal in the Software without restriction, including without limitation
 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included
 in all copies or substantial portions of the Software.
 THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.

Contents »