The secure-random Reference Manual

This is the secure-random Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:25:57 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 secure-random

Cryptographically secure pseudo-random number generator for Common Lisp

Author

Anton Vodonosov <>

License

MIT

Version

0.1.0

Dependency

cl+ssl (system).

Source

secure-random.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 secure-random/secure-random.asd

Source

secure-random.asd.

Parent Component

secure-random (system).

ASDF Systems

secure-random.


3.1.2 secure-random/package.lisp

Source

secure-random.asd.

Parent Component

secure-random (system).

Packages

secure-random.


3.1.3 secure-random/secure-random.lisp

Dependency

package.lisp (file).

Source

secure-random.asd.

Parent Component

secure-random (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 secure-random

Source

package.lisp.

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: *generator*
Package

secure-random.

Source

secure-random.lisp.


5.1.2 Ordinary functions

Function: number (limit &optional generator)

Returns a cryptographically strong pseudo-random number that is a non-negative number less than LIMIT and of the same type as LIMIT (in the current implementation, only INTEGER type is supporeted). LIMIT is a positive number. GENERATOR is an instance of a
subclass of the SECURE-RANDOM:GENERATOR. Signals an ERROR in case of problems (for example when the random number generator has not been initialized with enough entrophy).

Package

secure-random.

Source

secure-random.lisp.


5.1.3 Generic functions

Generic Function: bytes (count generator)

The only generic function which needs to be implemented by a subclass
of SECURE-RANDOM:GENERATOR. Generates COUNT cryptographically strong pseudo-random bytes using the random number generator GENERATOR. Returns the bytes as a SIMPLE-ARRAY with ELEMENT-TYPE ’(UNSIGNED-BYTE 8). Signals
an ERROR in case of problems (for example when the random number
generator has not been initialized with enough entrophy).

Package

secure-random.

Source

secure-random.lisp.

Methods
Method: bytes (count (generator open-ssl-generator))

5.1.4 Classes

Class: generator

The base class for all the possible implementations of secure random number generator.

Package

secure-random.

Source

secure-random.lisp.

Direct subclasses

open-ssl-generator.


5.2 Internals


5.2.1 Ordinary functions

Function: octets-to-integer (octets-vec)
Package

secure-random.

Source

secure-random.lisp.


5.2.2 Classes

Class: open-ssl-generator
Package

secure-random.

Source

secure-random.lisp.

Direct superclasses

generator.

Direct methods

bytes.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*generator*: Public special variables

S
Special Variable, *generator*: Public special variables