The jose Reference Manual

Table of Contents

The jose Reference Manual

This is the jose Reference Manual, version 0.1.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:02:35 2018 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

See Also

• JOSE Working Group

Author

• Eitaro Fukamachi (e.arrows@gmail.com)

Copyright

Copyright (c) 2017 Eitaro Fukamachi (e.arrows@gmail.com)

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

Dependencies

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

Source

jose.asd (file)

Component

lisp.lisp (file)

2.3 jose/jwt

Dependencies

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

Source

jose.asd (file)

Component

lisp.lisp (file)

2.4 jose/jws

Dependencies

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

Source

jose.asd (file)

Component

lisp.lisp (file)

2.5 jose/base64

Dependencies

• cl-base64
• trivial-utf-8

Source

jose.asd (file)

Component

lisp.lisp (file)

2.6 jose/errors

Source

jose.asd (file)

Component

lisp.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/lisp.lisp

Parent

jose/main (system)

Location

main.lisp

Packages

jose

3.1.3 jose/jwt/lisp.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/lisp.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)
• 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/lisp.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/lisp.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

lisp.lisp (file)

Nickname

jose/main

Use List

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

4.2 jose/jwt

Source

lisp.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

lisp.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)
• 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

lisp.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

lisp.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

lisp.lisp (file)

Function: base64url-encode INPUT

Package

jose/base64

Source

lisp.lisp (file)

Function: decode ALGORITHM KEY TOKEN &key ISSUER AUDIENCE SUBJECT

Package

jose/jwt

Source

lisp.lisp (file)

Function: decode-token TOKEN

Package

jose/jws

Source

lisp.lisp (file)

Function: encode ALGORITHM KEY CLAIMS &key HEADERS

Package

jose/jwt

Source

lisp.lisp (file)

Function: inspect-token TOKEN

Decodes the TOKEN without signature verification.

Package

jose/jwt

Source

lisp.lisp (file)

Function: sign ALGORITHM KEY PAYLOAD &key HEADERS

Package

jose/jws

Source

lisp.lisp (file)

Function: verify ALGORITHM KEY TOKEN

Package

jose/jws

Source

lisp.lisp (file)

5.1.2 Conditions

Condition: jose-error ()

Package

jose/errors

Source

lisp.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

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

Condition: jws-error ()

Package

jose/errors

Source

lisp.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

lisp.lisp (file)

Direct superclasses

jws-error (condition)

Direct slots

Slot: token

Initargs

:token

Condition: jws-verification-error ()

Package

jose/errors

Source

lisp.lisp (file)

Direct superclasses

jws-error (condition)

Direct slots

Slot: token

Initargs

:token

Condition: jwt-claims-error ()

Package

jose/errors

Source

lisp.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

lisp.lisp (file)

Direct superclasses

jwt-claims-error (condition)

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

Package

jose/errors

Source

lisp.lisp (file)

Direct superclasses

jwt-claims-error (condition)

Condition: jwt-error ()

Package

jose/errors

Source

lisp.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

lisp.lisp (file)

Function: add-padding INPUT

Package

jose/base64

Source

lisp.lisp (file)

Function: check-alg HEADERS ALGORITHM

Package

jose/jws

Source

lisp.lisp (file)

Function: check-aud CLAIMS AUDIENCE

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-claims CLAIMS &key ISSUER AUDIENCE SUBJECT

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-exp CLAIMS

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-iat CLAIMS

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-iss CLAIMS ISSUER

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-jti CLAIMS

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-nbf CLAIMS

Package

jose/jwt

Source

lisp.lisp (file)

Function: check-sub CLAIMS SUBJECT

Package

jose/jwt

Source

lisp.lisp (file)

Function: encode-headers ALGORITHM ADDITIONAL-HEADERS

Package

jose/jws

Source

lisp.lisp (file)

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

Package

jose/jws

Source

lisp.lisp (file)

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

Package

jose/jws

Source

lisp.lisp (file)

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

Package

jose/jws

Source

lisp.lisp (file)

Function: now ()

Package

jose/jwt

Source

lisp.lisp (file)

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

Package

jose/jws

Source

lisp.lisp (file)

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

Package

jose/jws

Source

lisp.lisp (file)

5.2.2 Types

Type: octets &optional LEN

Package

jose/base64

Source

lisp.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types