Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-scram Reference Manual

This is the cl-scram Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:41:08 2024 GMT+0.

Next: Systems, Previous: The cl-scram Reference Manual, Up: The cl-scram Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-scram Reference Manual [Contents][Index]

2 Systems

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

cl-scram

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-scram`

Common lisp library to implement SCRAM-SHA1 SASL mechanism.

Author

Matt Prelude <me@mprelu.de>

License

Revised BSD License (see LICENSE)

Version

0.1

Dependencies

cl-sasl (system).
cl-base64 (system).
ironclad (system).
secure-random (system).
split-sequence (system).

Source

cl-scram.asd.

Child Components

src (module).
readme.md (file).
license (file).

Next: Files, Previous: Systems, Up: The cl-scram Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

cl-scram/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-scram/src`

Source

cl-scram.asd.

Parent Component

cl-scram (system).

Child Components

packages.lisp (file).
conditions.lisp (file).
utils.lisp (file).
scram.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-scram Reference Manual [Contents][Index]

4 Files

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

Lisp
Static

Next: Static, Previous: Files, Up: Files [Contents][Index]

Next: cl-scram/src/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-scram/cl-scram.asd`

Source: cl-scram.asd.
Parent Component: cl-scram (system).
ASDF Systems: cl-scram.
Packages: cl-scram-asd.

Next: cl-scram/src/conditions.lisp, Previous: cl-scram/cl-scram.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-scram/src/packages.lisp`

Source: cl-scram.asd.
Parent Component: src (module).
Packages: cl-scram.

Next: cl-scram/src/utils.lisp, Previous: cl-scram/src/packages.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-scram/src/conditions.lisp`

Dependency: packages.lisp (file).
Source: cl-scram.asd.
Parent Component: src (module).

Next: cl-scram/src/scram.lisp, Previous: cl-scram/src/conditions.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-scram/src/utils.lisp`

Dependency

conditions.lisp (file).

Source

cl-scram.asd.

Parent Component

src (module).

Public Interface

base64-decode (function).
base64-encode (function).
base64-encode-octets (function).
gen-client-nonce (function).
gen-sasl-password (function).

Internals

bit-vector->integer (function).
gen-hmac-digest (function).
gen-sha1-digest (function).
integer->bit-vector (function).

Previous: cl-scram/src/utils.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-scram/src/scram.lisp`

Dependency

utils.lisp (file).

Source

cl-scram.asd.

Parent Component

src (module).

Public Interface

gen-client-encoded-initial-message (function).
gen-client-final-message (function).
gen-client-initial-message (function).
parse-server-iterations (function).
parse-server-nonce (function).
parse-server-salt (function).

Internals

parse-server-response (function).
text (reader method).
unexpected-nonce (condition).

Previous: Lisp, Up: Files [Contents][Index]

4.2 Static

cl-scram/README.md
cl-scram/LICENSE

Next: cl-scram/LICENSE, Previous: Static, Up: Static [Contents][Index]

4.2.1 `cl-scram/README.md`

Source: cl-scram.asd.
Parent Component: cl-scram (system).

Previous: cl-scram/README.md, Up: Static [Contents][Index]

4.2.2 `cl-scram/LICENSE`

Source: cl-scram.asd.
Parent Component: cl-scram (system).

Next: Definitions, Previous: Files, Up: The cl-scram Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-scram-asd
cl-scram

Next: cl-scram, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-scram-asd`

Source

cl-scram.asd.

Use List

asdf/interface.
common-lisp.

Previous: cl-scram-asd, Up: Packages [Contents][Index]

5.2 `cl-scram`

Source

packages.lisp.

Use List

common-lisp.
split-sequence.

Public Interface

base64-decode (function).
base64-encode (function).
base64-encode-octets (function).
gen-client-encoded-initial-message (function).
gen-client-final-message (function).
gen-client-initial-message (function).
gen-client-nonce (function).
gen-sasl-password (function).
parse-server-iterations (function).
parse-server-nonce (function).
parse-server-salt (function).

Internals

bit-vector->integer (function).
gen-hmac-digest (function).
gen-sha1-digest (function).
integer->bit-vector (function).
parse-server-response (function).
text (generic reader).
unexpected-nonce (condition).

Next: Indexes, Previous: Packages, Up: The cl-scram Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: base64-decode (string) ¶

Package: cl-scram.
Source: utils.lisp.

Function: base64-encode (string) ¶

Package: cl-scram.
Source: utils.lisp.

Function: base64-encode-octets (octets) ¶

Package: cl-scram.
Source: utils.lisp.

Function: gen-client-encoded-initial-message (&key username nonce) ¶

Package: cl-scram.
Source: scram.lisp.

Function: gen-client-final-message (&key password client-nonce client-initial-message server-response) ¶

Package: cl-scram.
Source: scram.lisp.

Function: gen-client-initial-message (&key username nonce) ¶

Package: cl-scram.
Source: scram.lisp.

Function: gen-client-nonce () ¶

Generate a random 32-character nonce.

Package: cl-scram.
Source: utils.lisp.

Function: gen-sasl-password (password) ¶

Package: cl-scram.
Source: utils.lisp.

Function: parse-server-iterations (&key response) ¶

Package: cl-scram.
Source: scram.lisp.

Function: parse-server-nonce (&key response nonce) ¶

Package: cl-scram.
Source: scram.lisp.

Function: parse-server-salt (&key response) ¶

Package: cl-scram.
Source: scram.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Ordinary functions
Generic functions
Conditions

Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Ordinary functions

Function: bit-vector->integer (bit-vector) ¶

Create a positive integer from a bit-vector.

Package: cl-scram.
Source: utils.lisp.

Function: gen-hmac-digest (&key key message) ¶

Takes a key & a message, and generates a HMAC digest.

Package: cl-scram.
Source: utils.lisp.

Function: gen-sha1-digest (&key key) ¶

Takes a key, and generates a SHA1 digest.

Package: cl-scram.
Source: utils.lisp.

Function: integer->bit-vector (integer) ¶

Create a bit-vector from a positive integer.

Package: cl-scram.
Source: utils.lisp.

Function: parse-server-response (&key response) ¶

Package: cl-scram.
Source: scram.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.2 Generic functions

Generic Reader: text (condition) ¶

Package

cl-scram.

Methods

Reader Method: text ((condition unexpected-nonce)) ¶

Source: scram.lisp.
Target Slot: text.

Previous: Generic functions, Up: Internals [Contents][Index]

6.2.3 Conditions

Condition: unexpected-nonce ¶

Package

cl-scram.

Source

scram.lisp.

Direct superclasses

error.

Direct methods

text.

Direct slots

Slot: text ¶

Initargs: :text
Readers: text.
Writers: This slot is read-only.

Previous: Definitions, Up: The cl-scram Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	B F G I M P T

	Index Entry	Section

B
	`base64-decode`:	Public ordinary functions
	`base64-encode`:	Public ordinary functions
	`base64-encode-octets`:	Public ordinary functions
	`bit-vector->integer`:	Private ordinary functions

F
	`Function, base64-decode`:	Public ordinary functions
	`Function, base64-encode`:	Public ordinary functions
	`Function, base64-encode-octets`:	Public ordinary functions
	`Function, bit-vector->integer`:	Private ordinary functions
	`Function, gen-client-encoded-initial-message`:	Public ordinary functions
	`Function, gen-client-final-message`:	Public ordinary functions
	`Function, gen-client-initial-message`:	Public ordinary functions
	`Function, gen-client-nonce`:	Public ordinary functions
	`Function, gen-hmac-digest`:	Private ordinary functions
	`Function, gen-sasl-password`:	Public ordinary functions
	`Function, gen-sha1-digest`:	Private ordinary functions
	`Function, integer->bit-vector`:	Private ordinary functions
	`Function, parse-server-iterations`:	Public ordinary functions
	`Function, parse-server-nonce`:	Public ordinary functions
	`Function, parse-server-response`:	Private ordinary functions
	`Function, parse-server-salt`:	Public ordinary functions

G
	`gen-client-encoded-initial-message`:	Public ordinary functions
	`gen-client-final-message`:	Public ordinary functions
	`gen-client-initial-message`:	Public ordinary functions
	`gen-client-nonce`:	Public ordinary functions
	`gen-hmac-digest`:	Private ordinary functions
	`gen-sasl-password`:	Public ordinary functions
	`gen-sha1-digest`:	Private ordinary functions
	`Generic Function, text`:	Private generic functions

I
	`integer->bit-vector`:	Private ordinary functions

M
	`Method, text`:	Private generic functions

P
	`parse-server-iterations`:	Public ordinary functions
	`parse-server-nonce`:	Public ordinary functions
	`parse-server-response`:	Private ordinary functions
	`parse-server-salt`:	Public ordinary functions

T
	`text`:	Private generic functions
	`text`:	Private generic functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	S T

	Index Entry	Section

S
	`Slot, text`:	Private conditions

T
	`text`:	Private conditions

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F L M P R S U

	Index Entry	Section

C
	`cl-scram`:	The cl-scram system
	`cl-scram`:	The cl-scram package
	`cl-scram-asd`:	The cl-scram-asd package
	`cl-scram.asd`:	The cl-scram/cl-scram․asd file
	`Condition, unexpected-nonce`:	Private conditions
	`conditions.lisp`:	The cl-scram/src/conditions․lisp file

F
	`File, cl-scram.asd`:	The cl-scram/cl-scram․asd file
	`File, conditions.lisp`:	The cl-scram/src/conditions․lisp file
	`File, license`:	The cl-scram/license file
	`File, packages.lisp`:	The cl-scram/src/packages․lisp file
	`File, readme.md`:	The cl-scram/readme․md file
	`File, scram.lisp`:	The cl-scram/src/scram․lisp file
	`File, utils.lisp`:	The cl-scram/src/utils․lisp file

L
	`license`:	The cl-scram/license file

M
	`Module, src`:	The cl-scram/src module

P
	`Package, cl-scram`:	The cl-scram package
	`Package, cl-scram-asd`:	The cl-scram-asd package
	`packages.lisp`:	The cl-scram/src/packages․lisp file

R
	`readme.md`:	The cl-scram/readme․md file

S
	`scram.lisp`:	The cl-scram/src/scram․lisp file
	`src`:	The cl-scram/src module
	`System, cl-scram`:	The cl-scram system

U
	`unexpected-nonce`:	Private conditions
	`utils.lisp`:	The cl-scram/src/utils․lisp file

The cl-scram Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-scram

3 Modules

3.1 cl-scram/src

4 Files

4.1 Lisp

4.1.1 cl-scram/cl-scram.asd

4.1.2 cl-scram/src/packages.lisp

4.1.3 cl-scram/src/conditions.lisp

4.1.4 cl-scram/src/utils.lisp

4.1.5 cl-scram/src/scram.lisp

4.2 Static

4.2.1 cl-scram/README.md

4.2.2 cl-scram/LICENSE

5 Packages

5.1 cl-scram-asd

5.2 cl-scram

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Ordinary functions

6.2.2 Generic functions

6.2.3 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-scram`

3.1 `cl-scram/src`

4.1.1 `cl-scram/cl-scram.asd`

4.1.2 `cl-scram/src/packages.lisp`

4.1.3 `cl-scram/src/conditions.lisp`

4.1.4 `cl-scram/src/utils.lisp`

4.1.5 `cl-scram/src/scram.lisp`

4.2.1 `cl-scram/README.md`

4.2.2 `cl-scram/LICENSE`

5.1 `cl-scram-asd`

5.2 `cl-scram`