The authenticated-encryption Reference Manual

Table of Contents

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

The authenticated-encryption Reference Manual

This is the authenticated-encryption Reference Manual, version 0.1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 14:31:43 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Authenticated-Encryption

A implementation of Authenticated Encryption

Usage

Encrypt

(aead::authenticated-encrypt plain-text-as-bytes :secret secret-bytes)
;=> encrypted-bytes

Decrypt

(aead::authenticated-decrypt encrypted-bytes :secret secret-bytes)
;=> plain-text-as-bytes
; or raise authenticated-decrypt-error condition

Installation

Cite


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 authenticated-encryption

Author

Koga Kazuo

License

MIT

Description

Authenticated-Encryption functions

Long Description

# Authenticated-Encryption

A implementation of Authenticated Encryption

## Usage

Encrypt

“‘
(aead::authenticated-encrypt plain-text-as-bytes :secret secret-bytes)
;=> encrypted-bytes
“‘

Decrypt

“‘
(aead::authenticated-decrypt encrypted-bytes :secret secret-bytes)
;=> plain-text-as-bytes
; or raise authenticated-decrypt-error condition
“‘

## Installation

## Cite

* https://en.wikipedia.org/wiki/Authenticated_encryption
* https://csrc.nist.gov/csrc/media/projects/block-cipher-techniques/documents/bcm/proposed-modes/eax/eax-spec.pdf

Version

0.1.0

Dependency

ironclad

Source

authenticated-encryption.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


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

3.1 authenticated-encryption/src

Parent

authenticated-encryption (system)

Location

src/

Component

authenticated-encryption.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 authenticated-encryption.asd

Location

authenticated-encryption.asd

Systems

authenticated-encryption (system)


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

4.1.2 authenticated-encryption/src/authenticated-encryption.lisp

Parent

src (module)

Location

src/authenticated-encryption.lisp

Packages

authenticated-encryption

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


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

5.1 authenticated-encryption

Source

authenticated-encryption.lisp (file)

Nickname

aead

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: authenticated-decrypt ENCRYPTED &key SECRET

Decrypt message with secret key

ENCRYPTED and SECRET must be array of (unsigned-byte 8).

Returns the decrypted bytes.

Conditions:
authenticated-decrypt-error when invalid encrypted bytes

Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Function: authenticated-encrypt MESSAGE &key SECRET NONCE CIPHER-NAME

Encrypt the message with secret key

MESSAGE and SECRET must be array of (unsigned-byte 8). NONCE will generate per evaluate if nil (default). CIPHER-NAME accepts only :AES (default) for now.

Returns the encrypted bytes.

Encrypted Bytes Format are:
Header (2 byte) +
Nonce (16 byte) +
Encrypted Message (with PKCS#7 padding) +
Tag (16 byte)
(16 = AES block size)

Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Conditions

Condition: authenticated-decrypt-error ()
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses
Condition: invalid-block-length-error ()
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Direct superclasses

authenticated-decrypt-error (condition)

Condition: invalid-cipher-error ()
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Direct superclasses

authenticated-decrypt-error (condition)

Condition: invalid-data-length-error ()
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Direct superclasses

authenticated-decrypt-error (condition)

Condition: invalid-header-error ()
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Direct superclasses

authenticated-decrypt-error (condition)

Condition: invalid-signature-error ()
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Direct superclasses

authenticated-decrypt-error (condition)


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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: make-header CIPHER BLOCK-LENGTH
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Function: make-nonce N-BYTES
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)

Function: pkcs7-padding DATA-LENGTH BLOCK-SIZE
Package

authenticated-encryption

Source

authenticated-encryption.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L   M  
Index Entry  Section

A
authenticated-encryption.asd: The authenticated-encryption<dot>asd file
authenticated-encryption/src: The authenticated-encryption/src module
authenticated-encryption/src/authenticated-encryption.lisp: The authenticated-encryption/src/authenticated-encryption<dot>lisp file

F
File, Lisp, authenticated-encryption.asd: The authenticated-encryption<dot>asd file
File, Lisp, authenticated-encryption/src/authenticated-encryption.lisp: The authenticated-encryption/src/authenticated-encryption<dot>lisp file

L
Lisp File, authenticated-encryption.asd: The authenticated-encryption<dot>asd file
Lisp File, authenticated-encryption/src/authenticated-encryption.lisp: The authenticated-encryption/src/authenticated-encryption<dot>lisp file

M
Module, authenticated-encryption/src: The authenticated-encryption/src module

Jump to:   A   F   L   M  

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

A.2 Functions

Jump to:   A   F   M   P  
Index Entry  Section

A
authenticated-decrypt: Exported functions
authenticated-encrypt: Exported functions

F
Function, authenticated-decrypt: Exported functions
Function, authenticated-encrypt: Exported functions
Function, make-header: Internal functions
Function, make-nonce: Internal functions
Function, pkcs7-padding: Internal functions

M
make-header: Internal functions
make-nonce: Internal functions

P
pkcs7-padding: Internal functions

Jump to:   A   F   M   P  

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

A.3 Variables


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

A.4 Data types

Jump to:   A   C   I   P   S  
Index Entry  Section

A
authenticated-decrypt-error: Exported conditions
authenticated-encryption: The authenticated-encryption system
authenticated-encryption: The authenticated-encryption package

C
Condition, authenticated-decrypt-error: Exported conditions
Condition, invalid-block-length-error: Exported conditions
Condition, invalid-cipher-error: Exported conditions
Condition, invalid-data-length-error: Exported conditions
Condition, invalid-header-error: Exported conditions
Condition, invalid-signature-error: Exported conditions

I
invalid-block-length-error: Exported conditions
invalid-cipher-error: Exported conditions
invalid-data-length-error: Exported conditions
invalid-header-error: Exported conditions
invalid-signature-error: Exported conditions

P
Package, authenticated-encryption: The authenticated-encryption package

S
System, authenticated-encryption: The authenticated-encryption system

Jump to:   A   C   I   P   S