The jose Reference Manual

This is the jose Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:39:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 jose

JSON Object Signing and Encryption (JOSE) implementation

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.1.0

Dependency

jose/main (system).

Source

jose.asd.


2.2 jose/main

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
Source

jose.asd.


2.3 jose/jwt

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
  • jose/errors (system).
  • jose/jws (system).
  • jonathan (system).
  • trivial-utf-8 (system).
  • alexandria (system).
  • assoc-utils (system).
Source

jose.asd.


2.4 jose/errors

Author

Eitaro Fukamachi

License

BSD 2-Clause

Source

jose.asd.


2.5 jose/jws

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
  • jose/base64 (system).
  • jose/errors (system).
  • ironclad (system).
  • jonathan (system).
  • split-sequence (system).
  • assoc-utils (system).
Source

jose.asd.


2.6 jose/base64

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
  • cl-base64 (system).
  • trivial-utf-8 (system).
Source

jose.asd.


3 Files

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


3.1 Lisp


3.1.1 jose/jose.asd

Source

jose.asd.

Parent Component

jose (system).

ASDF Systems

3.1.2 jose/main/file-type.lisp

Source

jose.asd.

Parent Component

jose/main (system).

Packages

jose.


3.1.3 jose/jwt/file-type.lisp

Source

jose.asd.

Parent Component

jose/jwt (system).

Packages

jose/jwt.

Public Interface
Internals

3.1.4 jose/errors/file-type.lisp

Source

jose.asd.

Parent Component

jose/errors (system).

Packages

jose/errors.

Public Interface

3.1.5 jose/jws/file-type.lisp

Source

jose.asd.

Parent Component

jose/jws (system).

Packages

jose/jws.

Public Interface
Internals

3.1.6 jose/base64/file-type.lisp

Source

jose.asd.

Parent Component

jose/base64 (system).

Packages

jose/base64.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 jose/base64

Source

file-type.lisp.

Use List

common-lisp.

Used By List

jose/jws.

Public Interface
Internals

4.2 jose/jwt

Source

file-type.lisp.

Use List
Used By List

jose.

Public Interface
Internals

4.3 jose

Source

file-type.lisp.

Nickname

jose/main

Use List

4.4 jose/errors

Source

file-type.lisp.

Use List

common-lisp.

Used By List
Public Interface

4.5 jose/jws

Source

file-type.lisp.

Use List
Used By List

jose.

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 Ordinary functions

Function: base64url-decode (input &key as)
Package

jose/base64.

Source

file-type.lisp.

Function: base64url-encode (input)
Package

jose/base64.

Source

file-type.lisp.

Function: decode (algorithm key token &key issuer audience subject)
Package

jose/jwt.

Source

file-type.lisp.

Function: decode-token (token)
Package

jose/jws.

Source

file-type.lisp.

Function: encode (algorithm key claims &key headers)
Package

jose/jwt.

Source

file-type.lisp.

Function: inspect-token (token)

Decodes the TOKEN without signature verification.

Package

jose/jwt.

Source

file-type.lisp.

Function: sign (algorithm key payload &key headers)
Package

jose/jws.

Source

file-type.lisp.

Function: verify (algorithm key token)
Package

jose/jws.

Source

file-type.lisp.


5.1.2 Conditions

Condition: jose-error
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

error.

Direct subclasses
Condition: jws-error
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jose-error.

Direct subclasses
Condition: jws-invalid-format
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jws-error.

Direct slots
Slot: token
Initargs

:token

Condition: jws-verification-error
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jws-error.

Direct slots
Slot: token
Initargs

:token

Condition: jwt-claims-error
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jwt-error.

Direct subclasses
Direct slots
Slot: key
Initargs

:key

Slot: value
Initargs

:value

Condition: jwt-claims-expired
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jwt-claims-error.

Condition: jwt-claims-not-yet-valid
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jwt-claims-error.

Condition: jwt-error
Package

jose/errors.

Source

file-type.lisp.

Direct superclasses

jose-error.

Direct subclasses

jwt-claims-error.


5.2 Internals


5.2.1 Ordinary functions

Function: %verify-message (algorithm key message signature &key start end)
Package

jose/jws.

Source

file-type.lisp.

Function: add-padding (input)
Package

jose/base64.

Source

file-type.lisp.

Function: check-alg (headers algorithm)
Package

jose/jws.

Source

file-type.lisp.

Function: check-aud (claims audience)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-claims (claims &key issuer audience subject)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-exp (claims)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-iat (claims)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-iss (claims issuer)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-jti (claims)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-nbf (claims)
Package

jose/jwt.

Source

file-type.lisp.

Function: check-sub (claims subject)
Package

jose/jwt.

Source

file-type.lisp.

Function: digest-with-pkcs1-padding (digest-spec message &key start end key-length)
Package

jose/jws.

Source

file-type.lisp.

Function: encode-headers (algorithm additional-headers)
Package

jose/jws.

Source

file-type.lisp.

Function: get-signature (algorithm key message &key start end)
Package

jose/jws.

Source

file-type.lisp.

Function: hmac-sign-message (digest-spec secret-key message &key start end)
Package

jose/jws.

Source

file-type.lisp.

Function: hmac-verify-signature (digest-spec verification-key message signature &key start end)
Package

jose/jws.

Source

file-type.lisp.

Function: now ()
Package

jose/jwt.

Source

file-type.lisp.

Function: rsa-sign-message (digest-spec private-key message &key start end pss)
Package

jose/jws.

Source

file-type.lisp.

Function: rsa-verify-signature (digest-spec public-key message signature &key start end pss)
Package

jose/jws.

Source

file-type.lisp.


5.2.2 Types

Type: octets (&optional len)
Package

jose/base64.

Source

file-type.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

%
%verify-message: Private ordinary functions

A
add-padding: Private ordinary functions

B
base64url-decode: Public ordinary functions
base64url-encode: Public ordinary functions

C
check-alg: Private ordinary functions
check-aud: Private ordinary functions
check-claims: Private ordinary functions
check-exp: Private ordinary functions
check-iat: Private ordinary functions
check-iss: Private ordinary functions
check-jti: Private ordinary functions
check-nbf: Private ordinary functions
check-sub: Private ordinary functions

D
decode: Public ordinary functions
decode-token: Public ordinary functions
digest-with-pkcs1-padding: Private ordinary functions

E
encode: Public ordinary functions
encode-headers: Private ordinary functions

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

G
get-signature: Private ordinary functions

H
hmac-sign-message: Private ordinary functions
hmac-verify-signature: Private ordinary functions

I
inspect-token: Public ordinary functions

N
now: Private ordinary functions

R
rsa-sign-message: Private ordinary functions
rsa-verify-signature: Private ordinary functions

S
sign: Public ordinary functions

V
verify: Public ordinary functions


A.3 Variables


A.4 Data types

Jump to:   C   F   J   O   P   S   T  
Index Entry  Section

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

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

J
jose: The jose system
jose: The jose package
jose-error: Public conditions
jose.asd: The jose/jose․asd file
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: Public conditions
jws-invalid-format: Public conditions
jws-verification-error: Public conditions
jwt-claims-error: Public conditions
jwt-claims-expired: Public conditions
jwt-claims-not-yet-valid: Public conditions
jwt-error: Public conditions

O
octets: Private 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: Private types