The cl-one-time-passwords Reference Manual

This is the cl-one-time-passwords Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:17:51 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-one-time-passwords

One time passwords (hotp rfc4226, totp rfc6238) as used in two factor authentication systems such as Google’s.

Author

Ben Hyde <>

License

Apache 2.0

Dependency

ironclad (system).

Source

cl-one-time-passwords.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-one-time-passwords/cl-one-time-passwords.asd

Source

cl-one-time-passwords.asd.

Parent Component

cl-one-time-passwords (system).

ASDF Systems

cl-one-time-passwords.


3.1.2 cl-one-time-passwords/packages.lisp

Source

cl-one-time-passwords.asd.

Parent Component

cl-one-time-passwords (system).

Packages

3.1.3 cl-one-time-passwords/hotp.lisp

Dependency

packages.lisp (file).

Source

cl-one-time-passwords.asd.

Parent Component

cl-one-time-passwords (system).

Public Interface
Internals

3.1.4 cl-one-time-passwords/totp.lisp

Dependency

hotp.lisp (file).

Source

cl-one-time-passwords.asd.

Parent Component

cl-one-time-passwords (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-hotp

Source

packages.lisp.

Nickname

hotp

Use List

common-lisp.

Public Interface
Internals

4.2 cl-totp

Source

packages.lisp.

Nickname

totp

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *digits*
Package

cl-hotp.

Source

hotp.lisp.

Special Variable: *hmac-sha-mode*
Package

cl-hotp.

Source

hotp.lisp.

Special Variable: *time-step-in-seconds*
Package

cl-totp.

Source

totp.lisp.

Special Variable: *time-zero*
Package

cl-totp.

Source

totp.lisp.


5.1.2 Ordinary functions

Function: hotp (key-string counter)
Package

cl-hotp.

Source

hotp.lisp.

Function: totp (key-hexstring &optional offset time)
Package

cl-totp.

Source

totp.lisp.


5.2 Internals


5.2.1 Constants

Constant: .unix-epoch-zero.
Package

cl-totp.

Source

totp.lisp.


5.2.2 Macros

Macro: time-step (unix-time)
Package

cl-totp.

Source

totp.lisp.


5.2.3 Ordinary functions

Function: hmac-sha-n (key-string counter)
Package

cl-hotp.

Source

hotp.lisp.

Function: hotp-truncate (20-bytes)
Package

cl-hotp.

Source

hotp.lisp.


Appendix A Indexes


A.1 Concepts