The sha1 Reference Manual

This is the sha1 Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:26:55 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 sha1

SHA1 Digest and HMAC for Common Lisp.

Author

Jeffrey Massung

License

Apache 2.0

Version

1.0

Source

sha1.asd.

Child Component

sha1.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 sha1/sha1.asd

Source

sha1.asd.

Parent Component

sha1 (system).

ASDF Systems

sha1.

Packages

sha1-asd.


3.1.2 sha1/sha1.lisp

Source

sha1.asd.

Parent Component

sha1 (system).

Packages

sha1.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 sha1

Source

sha1.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 sha1-asd

Source

sha1.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: hmac-sha1-base64 (key message &optional base64-encoder)

Return the HMAC-SHA1 base64-encoded digest for a byte sequence.

Package

sha1.

Source

sha1.lisp.

Function: hmac-sha1-digest (key message)

Return the HMAC-SHA1 digest for a byte sequence.

Package

sha1.

Source

sha1.lisp.

Function: hmac-sha1-hex (key message)

Return the HMAC-SHA1 hex digest for a byte sequence.

Package

sha1.

Source

sha1.lisp.

Function: sha1-base64 (message &optional base64-encoder)

Return the SHA1 base64-encoded digest for a byte sequence.

Package

sha1.

Source

sha1.lisp.

Function: sha1-digest (message)

Return the SHA1 digest for a byte sequence.

Package

sha1.

Source

sha1.lisp.

Function: sha1-hex (message)

Return the SHA1 hex digest for a byte sequence.

Package

sha1.

Source

sha1.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *base64-encoder*

SHA1-BASE64 and HMAC-SHA1-BASE64 use this function if no encoder is provided.

Package

sha1.

Source

sha1.lisp.


5.2.2 Ordinary functions

Function: digest (seq)

Create a SHA-1 digest from an adjustable vector containing the message.

Package

sha1.

Source

sha1.lisp.

Function: hash-digest (hh)

Convert a 160-bit hash to a 20-byte digest list.

Package

sha1.

Source

sha1.lisp.

Function: hash-vector (seq)

Convert x to an unsigned-byte vector.

Package

sha1.

Source

sha1.lisp.

Function: rotate-word (w &optional bits)

Rotate a 32-bit word left by bits.

Package

sha1.

Source

sha1.lisp.

Function: word (v chunk byte)

Read a 32-bit, big-endian word from a message chunk.

Package

sha1.

Source

sha1.lisp.


5.2.3 Types

Type: function-designator ()
Package

sha1.

Source

sha1.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*base64-encoder*: Private special variables

S
Special Variable, *base64-encoder*: Private special variables