The jose Reference Manual

This is the jose Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:31:44 2021 GMT+0.

1 Introduction

jose

A JSON Object Signing and Encryption (JOSE) implementation for Common Lisp.

Usage

(defvar *key* (ironclad:ascii-string-to-byte-array "my$ecret"))

(defvar *token*
  (jose:encode :hs256 *key* '(("hello" . "world"))))

*token*
;=> "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJoZWxsbyI6IndvcmxkIn0.Vr0VKL9WHX9lUPWzrE0DX4fEvl0_CgnKlzI2mWiro8E"

(jose:decode :hs256 *key* *token*)
;=> (("hello" . "world"))
;   (("alg" . "HS256") ("typ" . "JWT"))

;; Decoding without signature verification.
(jose:inspect-token *token*)
;=> (("hello" . "world"))
;   (("alg" . "HS256") ("typ" . "JWT"))
;   #(142 123 175 222 84 4 134 19 70 182 50 209 29 113 176 40 82 42 241 90 230 91
;     176 235 254 57 221 93 97 220 6 101)

Supported Algorithms

HS256
HS384
HS512
RS256
RS384
RS512
PS256
PS384
PS512
none

Author

Eitaro Fukamachi (e.arrows@gmail.com)

Copyright

License

Licensed under the BSD 2-Clause License.

2 Systems

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

2.1 `jose`

Author: Eitaro Fukamachi
License: BSD 2-Clause
Description: JSON Object Signing and Encryption (JOSE) implementation
Version: 0.1.0
Dependency: jose/main (system)
Source: jose.asd (file)

2.2 `jose/main`

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

jose/jwt (system)
jose/jws (system)
jose/errors (system)

Source

jose.asd (file)

Component

file-type.lisp (file)

2.3 `jose/jwt`

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

jose/errors (system)
jose/jws (system)
jonathan
trivial-utf-8
alexandria
assoc-utils

Source

jose.asd (file)

Component

file-type.lisp (file)

2.4 `jose/jws`

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

jose/base64 (system)
jose/errors (system)
ironclad
jonathan
split-sequence
assoc-utils

Source

jose.asd (file)

Component

file-type.lisp (file)

2.5 `jose/base64`

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

cl-base64
trivial-utf-8

Source

jose.asd (file)

Component

file-type.lisp (file)

2.6 `jose/errors`

Author: Eitaro Fukamachi
License: BSD 2-Clause
Source: jose.asd (file)
Component: file-type.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 `jose.asd`

Location

jose.asd

Systems

jose (system)
jose/main (system)
jose/jwt (system)
jose/jws (system)
jose/base64 (system)
jose/errors (system)

3.1.2 `jose/main/file-type.lisp`

Parent: jose/main (system)
Location: main.lisp
Packages: jose

3.1.3 `jose/jwt/file-type.lisp`

Parent

jose/jwt (system)

Location

jwt.lisp

Packages

jose/jwt

Exported Definitions

decode (function)
encode (function)
inspect-token (function)

Internal Definitions

check-aud (function)
check-claims (function)
check-exp (function)
check-iat (function)
check-iss (function)
check-jti (function)
check-nbf (function)
check-sub (function)
now (function)

3.1.4 `jose/jws/file-type.lisp`

Parent

jose/jws (system)

Location

jws.lisp

Packages

jose/jws

Exported Definitions

decode-token (function)
sign (function)
verify (function)

Internal Definitions

%verify-message (function)
check-alg (function)
digest-with-pkcs1-padding (function)
encode-headers (function)
get-signature (function)
hmac-sign-message (function)
hmac-verify-signature (function)
rsa-sign-message (function)
rsa-verify-signature (function)

3.1.5 `jose/base64/file-type.lisp`

Parent

jose/base64 (system)

Location

base64.lisp

Packages

jose/base64

Exported Definitions

base64url-decode (function)
base64url-encode (function)

Internal Definitions

add-padding (function)
octets (type)

3.1.6 `jose/errors/file-type.lisp`

Parent

jose/errors (system)

Location

errors.lisp

Packages

jose/errors

Exported Definitions

jose-error (condition)
jws-error (condition)
jws-invalid-format (condition)
jws-verification-error (condition)
jwt-claims-error (condition)
jwt-claims-expired (condition)
jwt-claims-not-yet-valid (condition)
jwt-error (condition)

4 Packages

Packages are listed by definition order.

4.1 `jose`

Source

file-type.lisp (file)

Nickname

jose/main

Use List

jose/errors
jose/jws
jose/jwt
common-lisp

4.2 `jose/jwt`

Source

file-type.lisp (file)

Use List

jose/errors
common-lisp

Used By List

jose

Exported Definitions

decode (function)
encode (function)
inspect-token (function)

Internal Definitions

check-aud (function)
check-claims (function)
check-exp (function)
check-iat (function)
check-iss (function)
check-jti (function)
check-nbf (function)
check-sub (function)
now (function)

4.3 `jose/jws`

Source

file-type.lisp (file)

Use List

jose/errors
jose/base64
common-lisp

Used By List

jose

Exported Definitions

decode-token (function)
sign (function)
verify (function)

Internal Definitions

%verify-message (function)
check-alg (function)
digest-with-pkcs1-padding (function)
encode-headers (function)
get-signature (function)
hmac-sign-message (function)
hmac-verify-signature (function)
rsa-sign-message (function)
rsa-verify-signature (function)

4.4 `jose/base64`

Source

file-type.lisp (file)

Use List

common-lisp

Used By List

jose/jws

Exported Definitions

base64url-decode (function)
base64url-encode (function)

Internal Definitions

add-padding (function)
octets (type)

4.5 `jose/errors`

Source

file-type.lisp (file)

Use List

common-lisp

Used By List

jose
jose/jwt
jose/jws

Exported Definitions

jose-error (condition)
jws-error (condition)
jws-invalid-format (condition)
jws-verification-error (condition)
jwt-claims-error (condition)
jwt-claims-expired (condition)
jwt-claims-not-yet-valid (condition)
jwt-error (condition)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: base64url-decode INPUT &key AS

Package: jose/base64
Source: file-type.lisp (file)

Function: base64url-encode INPUT

Package: jose/base64
Source: file-type.lisp (file)

Function: decode ALGORITHM KEY TOKEN &key ISSUER AUDIENCE SUBJECT

Package: jose/jwt
Source: file-type.lisp (file)

Function: decode-token TOKEN

Package: jose/jws
Source: file-type.lisp (file)

Function: encode ALGORITHM KEY CLAIMS &key HEADERS

Package: jose/jwt
Source: file-type.lisp (file)

Function: inspect-token TOKEN

Decodes the TOKEN without signature verification.

Package: jose/jwt
Source: file-type.lisp (file)

Function: sign ALGORITHM KEY PAYLOAD &key HEADERS

Package: jose/jws
Source: file-type.lisp (file)

Function: verify ALGORITHM KEY TOKEN

Package: jose/jws
Source: file-type.lisp (file)

5.1.2 Conditions

Condition: jose-error ()

Package

jose/errors

Source

file-type.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

jws-error (condition)
jwt-error (condition)

Condition: jws-error ()

Package

jose/errors

Source

file-type.lisp (file)

Direct superclasses

jose-error (condition)

Direct subclasses

jws-verification-error (condition)
jws-invalid-format (condition)

Condition: jws-invalid-format ()

Package

jose/errors

Source

file-type.lisp (file)

Direct superclasses

jws-error (condition)

Direct slots

Slot: token

Initargs: :token

Condition: jws-verification-error ()

Package

jose/errors

Source

file-type.lisp (file)

Direct superclasses

jws-error (condition)

Direct slots

Slot: token

Initargs: :token

Condition: jwt-claims-error ()

Package

jose/errors

Source

file-type.lisp (file)

Direct superclasses

jwt-error (condition)

Direct subclasses

jwt-claims-not-yet-valid (condition)
jwt-claims-expired (condition)

Direct slots

Slot: key

Initargs: :key

Slot: value

Initargs: :value

Condition: jwt-claims-expired ()

Package: jose/errors
Source: file-type.lisp (file)
Direct superclasses: jwt-claims-error (condition)

Condition: jwt-claims-not-yet-valid ()

Package: jose/errors
Source: file-type.lisp (file)
Direct superclasses: jwt-claims-error (condition)

Condition: jwt-error ()

Package: jose/errors
Source: file-type.lisp (file)
Direct superclasses: jose-error (condition)
Direct subclasses: jwt-claims-error (condition)

5.2 Internal definitions

5.2.1 Functions

Function: %verify-message ALGORITHM KEY MESSAGE SIGNATURE &key START END

Package: jose/jws
Source: file-type.lisp (file)

Function: add-padding INPUT

Package: jose/base64
Source: file-type.lisp (file)

Function: check-alg HEADERS ALGORITHM

Package: jose/jws
Source: file-type.lisp (file)

Function: check-aud CLAIMS AUDIENCE

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-claims CLAIMS &key ISSUER AUDIENCE SUBJECT

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-exp CLAIMS

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-iat CLAIMS

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-iss CLAIMS ISSUER

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-jti CLAIMS

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-nbf CLAIMS

Package: jose/jwt
Source: file-type.lisp (file)

Function: check-sub CLAIMS SUBJECT

Package: jose/jwt
Source: file-type.lisp (file)

Function: digest-with-pkcs1-padding DIGEST-SPEC MESSAGE &key START END KEY-LENGTH

Package: jose/jws
Source: file-type.lisp (file)

Function: encode-headers ALGORITHM ADDITIONAL-HEADERS

Package: jose/jws
Source: file-type.lisp (file)

Function: get-signature ALGORITHM KEY MESSAGE &key START END

Package: jose/jws
Source: file-type.lisp (file)

Function: hmac-sign-message DIGEST-SPEC SECRET-KEY MESSAGE &key START END

Package: jose/jws
Source: file-type.lisp (file)

Function: hmac-verify-signature DIGEST-SPEC VERIFICATION-KEY MESSAGE SIGNATURE &key START END

Package: jose/jws
Source: file-type.lisp (file)

Function: now ()

Package: jose/jwt
Source: file-type.lisp (file)

Function: rsa-sign-message DIGEST-SPEC PRIVATE-KEY MESSAGE &key START END PSS

Package: jose/jws
Source: file-type.lisp (file)

Function: rsa-verify-signature DIGEST-SPEC PUBLIC-KEY MESSAGE SIGNATURE &key START END PSS

Package: jose/jws
Source: file-type.lisp (file)

5.2.2 Types

Type: octets &optional LEN

Package: jose/base64
Source: file-type.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	F J L

	Index Entry	Section

F
	File, Lisp, `jose.asd`:	The jose․asd file
	File, Lisp, `jose/base64/file-type.lisp`:	The jose/base64/file-type․lisp file
	File, Lisp, `jose/errors/file-type.lisp`:	The jose/errors/file-type․lisp file
	File, Lisp, `jose/jws/file-type.lisp`:	The jose/jws/file-type․lisp file
	File, Lisp, `jose/jwt/file-type.lisp`:	The jose/jwt/file-type․lisp file
	File, Lisp, `jose/main/file-type.lisp`:	The jose/main/file-type․lisp file

J
	`jose.asd`:	The jose․asd file
	`jose/base64/file-type.lisp`:	The jose/base64/file-type․lisp file
	`jose/errors/file-type.lisp`:	The jose/errors/file-type․lisp file
	`jose/jws/file-type.lisp`:	The jose/jws/file-type․lisp file
	`jose/jwt/file-type.lisp`:	The jose/jwt/file-type․lisp file
	`jose/main/file-type.lisp`:	The jose/main/file-type․lisp file

L
	Lisp File, `jose.asd`:	The jose․asd file
	Lisp File, `jose/base64/file-type.lisp`:	The jose/base64/file-type․lisp file
	Lisp File, `jose/errors/file-type.lisp`:	The jose/errors/file-type․lisp file
	Lisp File, `jose/jws/file-type.lisp`:	The jose/jws/file-type․lisp file
	Lisp File, `jose/jwt/file-type.lisp`:	The jose/jwt/file-type․lisp file
	Lisp File, `jose/main/file-type.lisp`:	The jose/main/file-type․lisp file

Jump to:	F J L

A.2 Functions

Jump to:	% A B C D E F G H I N R S V

	Index Entry	Section

%
	`%verify-message`:	Internal functions

A
	`add-padding`:	Internal functions

B
	`base64url-decode`:	Exported functions
	`base64url-encode`:	Exported functions

C
	`check-alg`:	Internal functions
	`check-aud`:	Internal functions
	`check-claims`:	Internal functions
	`check-exp`:	Internal functions
	`check-iat`:	Internal functions
	`check-iss`:	Internal functions
	`check-jti`:	Internal functions
	`check-nbf`:	Internal functions
	`check-sub`:	Internal functions

D
	`decode`:	Exported functions
	`decode-token`:	Exported functions
	`digest-with-pkcs1-padding`:	Internal functions

E
	`encode`:	Exported functions
	`encode-headers`:	Internal functions

F
	`Function, %verify-message`:	Internal functions
	`Function, add-padding`:	Internal functions
	`Function, base64url-decode`:	Exported functions
	`Function, base64url-encode`:	Exported functions
	`Function, check-alg`:	Internal functions
	`Function, check-aud`:	Internal functions
	`Function, check-claims`:	Internal functions
	`Function, check-exp`:	Internal functions
	`Function, check-iat`:	Internal functions
	`Function, check-iss`:	Internal functions
	`Function, check-jti`:	Internal functions
	`Function, check-nbf`:	Internal functions
	`Function, check-sub`:	Internal functions
	`Function, decode`:	Exported functions
	`Function, decode-token`:	Exported functions
	`Function, digest-with-pkcs1-padding`:	Internal functions
	`Function, encode`:	Exported functions
	`Function, encode-headers`:	Internal functions
	`Function, get-signature`:	Internal functions
	`Function, hmac-sign-message`:	Internal functions
	`Function, hmac-verify-signature`:	Internal functions
	`Function, inspect-token`:	Exported functions
	`Function, now`:	Internal functions
	`Function, rsa-sign-message`:	Internal functions
	`Function, rsa-verify-signature`:	Internal functions
	`Function, sign`:	Exported functions
	`Function, verify`:	Exported functions

G
	`get-signature`:	Internal functions

H
	`hmac-sign-message`:	Internal functions
	`hmac-verify-signature`:	Internal functions

I
	`inspect-token`:	Exported functions

N
	`now`:	Internal functions

R
	`rsa-sign-message`:	Internal functions
	`rsa-verify-signature`:	Internal functions

S
	`sign`:	Exported functions

V
	`verify`:	Exported functions

Jump to:	% A B C D E F G H I N R S V

A.3 Variables

Jump to:	K S T V

	Index Entry	Section

K
	`key`:	Exported conditions

S
	`Slot, key`:	Exported conditions
	`Slot, token`:	Exported conditions
	`Slot, token`:	Exported conditions
	`Slot, value`:	Exported conditions

T
	`token`:	Exported conditions
	`token`:	Exported conditions

V
	`value`:	Exported conditions

Jump to:	K S T V

A.4 Data types

Jump to:	C J O P S T

	Index Entry	Section

C
	`Condition, jose-error`:	Exported conditions
	`Condition, jws-error`:	Exported conditions
	`Condition, jws-invalid-format`:	Exported conditions
	`Condition, jws-verification-error`:	Exported conditions
	`Condition, jwt-claims-error`:	Exported conditions
	`Condition, jwt-claims-expired`:	Exported conditions
	`Condition, jwt-claims-not-yet-valid`:	Exported conditions
	`Condition, jwt-error`:	Exported conditions

J
	`jose`:	The jose system
	`jose`:	The jose package
	`jose-error`:	Exported conditions
	`jose/base64`:	The jose/base64 system
	`jose/base64`:	The jose/base64 package
	`jose/errors`:	The jose/errors system
	`jose/errors`:	The jose/errors package
	`jose/jws`:	The jose/jws system
	`jose/jws`:	The jose/jws package
	`jose/jwt`:	The jose/jwt system
	`jose/jwt`:	The jose/jwt package
	`jose/main`:	The jose/main system
	`jws-error`:	Exported conditions
	`jws-invalid-format`:	Exported conditions
	`jws-verification-error`:	Exported conditions
	`jwt-claims-error`:	Exported conditions
	`jwt-claims-expired`:	Exported conditions
	`jwt-claims-not-yet-valid`:	Exported conditions
	`jwt-error`:	Exported conditions

O
	`octets`:	Internal types

P
	`Package, jose`:	The jose package
	`Package, jose/base64`:	The jose/base64 package
	`Package, jose/errors`:	The jose/errors package
	`Package, jose/jws`:	The jose/jws package
	`Package, jose/jwt`:	The jose/jwt package

S
	`System, jose`:	The jose system
	`System, jose/base64`:	The jose/base64 system
	`System, jose/errors`:	The jose/errors system
	`System, jose/jws`:	The jose/jws system
	`System, jose/jwt`:	The jose/jwt system
	`System, jose/main`:	The jose/main system

T
	`Type, octets`:	Internal types

Jump to:	C J O P S T

• Introduction		What jose is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The jose system
• The jose/main system
• The jose/jwt system
• The jose/jws system
• The jose/base64 system
• The jose/errors system

• The jose.asd file
• The jose/main/file-type.lisp file
• The jose/jwt/file-type.lisp file
• The jose/jws/file-type.lisp file
• The jose/base64/file-type.lisp file
• The jose/errors/file-type.lisp file

• The jose package
• The jose/jwt package
• The jose/jws package
• The jose/base64 package
• The jose/errors package

• Concept index
• Function index
• Variable index
• Data type index

The jose Reference Manual

Table of Contents

The jose Reference Manual

1 Introduction

jose

Usage

Supported Algorithms

See Also

Author

Copyright

License

2 Systems

2.1 jose

2.2 jose/main

2.3 jose/jwt

2.4 jose/jws

2.5 jose/base64

2.6 jose/errors

3 Files

3.1 Lisp

3.1.1 jose.asd

3.1.2 jose/main/file-type.lisp

3.1.3 jose/jwt/file-type.lisp

3.1.4 jose/jws/file-type.lisp

3.1.5 jose/base64/file-type.lisp

3.1.6 jose/errors/file-type.lisp

4 Packages

4.1 jose

4.2 jose/jwt

4.3 jose/jws

4.4 jose/base64

4.5 jose/errors

5 Definitions

5.1 Exported definitions

5.1.1 Functions

5.1.2 Conditions

5.2 Internal definitions

5.2.1 Functions

5.2.2 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `jose`

2.2 `jose/main`

2.3 `jose/jwt`

2.4 `jose/jws`

2.5 `jose/base64`

2.6 `jose/errors`

3.1.1 `jose.asd`

3.1.2 `jose/main/file-type.lisp`

3.1.3 `jose/jwt/file-type.lisp`

3.1.4 `jose/jws/file-type.lisp`

3.1.5 `jose/base64/file-type.lisp`

3.1.6 `jose/errors/file-type.lisp`

4.1 `jose`

4.2 `jose/jwt`

4.3 `jose/jws`

4.4 `jose/base64`

4.5 `jose/errors`