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

The openid-key Reference Manual

This is the openid-key Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:16:22 2024 GMT+0.

Next: Systems, Previous: The openid-key Reference Manual, Up: The openid-key Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The openid-key Reference Manual [Contents][Index]

2 Systems

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

openid-key

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

2.1 `openid-key`

Get OpenID keys from issuer.

Author

Koga Kazuo

License

MIT

Long Description

# Openid-Key

You can get public key of OpenID Connect [id-token][id-token].
Then, you can verify id-token with the key.

OpedID Key format has defined in [JSON Web Key (JWK)][JWK].

## Usage

“‘
CL-USER> (setf *keys* (openid-key:get-openid-keys "https://accounts.google.com")) #S(OPENID-KEY::OPENID-KEYS
:ISSUER "https://accounts.google.com"
:JWKS-EXPIRES @2018-11-03T20:03:46.000000+09:00
:KEYS (#S(OPENID-KEY::OPENID-KEY
:KTY "RSA"
:USE "sig"
:ALG "RS256"
:KID "8289d54280b76712de41cd2ef95972b123be9ac0"
:KEY #<IRONCLAD::RSA-PUBLIC-KEY {1001EE03A3}>) #S(OPENID-KEY::OPENID-KEY
:KTY "RSA"
:USE "sig"
:ALG "RS256"
:KID "aa436c3f63b281ce0d976da0b51a34860ff960eb"
:KEY #<IRONCLAD::RSA-PUBLIC-KEY {1001F40433}>)))
CL-USER> (openid-key:find-openid-key "8289d54280b76712de41cd2ef95972b123be9ac0" *keys*) #<IRONCLAD::RSA-PUBLIC-KEY {1001B512E3}>
"RS256"
"RSA"
"sig"
“‘

You may also be interested in [Jose][Jose] for verify [id-token][id-token].

## Installation

[Jose]: http://quickdocs.org/jose/
[JWK]: https://tools.ietf.org/html/rfc7517
[id-token]: https://openid.net/specs/openid-connect-core-1_0.html

Version

0.1.1

Dependencies

cl-base64 (system).
dexador (system).
ironclad (system).
jonathan (system).
local-time (system).
quri (system).
trivial-rfc-1123 (system).

Source

openid-key.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The openid-key Reference Manual [Contents][Index]

3 Modules

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

openid-key/src

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

3.1 `openid-key/src`

Source: openid-key.asd.
Parent Component: openid-key (system).
Child Component: openid-key.lisp (file).

Next: Packages, Previous: Modules, Up: The openid-key Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: openid-key/src/openid-key.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `openid-key/openid-key.asd`

Source: openid-key.asd.
Parent Component: openid-key (system).
ASDF Systems: openid-key.

Previous: openid-key/openid-key.asd, Up: Lisp [Contents][Index]

4.1.2 `openid-key/src/openid-key.lisp`

Source

openid-key.asd.

Parent Component

src (module).

Packages

openid-key.

Public Interface

find-openid-key (function).
get-openid-keys (function).
openid-keys (structure).

Internals

b64-integer (function).
config-endpoint (function).
copy-openid-key (function).
copy-openid-keys (function).
get-expires (function).
issuer-endpoint (function).
jwk-key (function).
make-openid-key (function).
make-openid-keys (function).
openid-key (structure).
openid-key-alg (reader).
(setf openid-key-alg) (writer).
openid-key-key (reader).
(setf openid-key-key) (writer).
openid-key-kid (reader).
(setf openid-key-kid) (writer).
openid-key-kty (reader).
(setf openid-key-kty) (writer).
openid-key-p (function).
openid-key-use (reader).
(setf openid-key-use) (writer).
openid-keys-issuer (reader).
(setf openid-keys-issuer) (writer).
openid-keys-jwks-expires (reader).
(setf openid-keys-jwks-expires) (writer).
openid-keys-keys (reader).
(setf openid-keys-keys) (writer).
openid-keys-p (function).

Next: Definitions, Previous: Files, Up: The openid-key Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

openid-key

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

5.1 `openid-key`

Source

openid-key.lisp.

Use List

common-lisp.

Public Interface

find-openid-key (function).
get-openid-keys (function).
openid-keys (structure).

Internals

b64-integer (function).
config-endpoint (function).
copy-openid-key (function).
copy-openid-keys (function).
get-expires (function).
issuer-endpoint (function).
jwk-key (function).
make-openid-key (function).
make-openid-keys (function).
openid-key (structure).
openid-key-alg (reader).
(setf openid-key-alg) (writer).
openid-key-key (reader).
(setf openid-key-key) (writer).
openid-key-kid (reader).
(setf openid-key-kid) (writer).
openid-key-kty (reader).
(setf openid-key-kty) (writer).
openid-key-p (function).
openid-key-use (reader).
(setf openid-key-use) (writer).
openid-keys-issuer (reader).
(setf openid-keys-issuer) (writer).
openid-keys-jwks-expires (reader).
(setf openid-keys-jwks-expires) (writer).
openid-keys-keys (reader).
(setf openid-keys-keys) (writer).
openid-keys-p (function).

Next: Indexes, Previous: Packages, Up: The openid-key Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Ordinary functions
Structures

Next: Structures, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: find-openid-key (kid keys) ¶

Find key by key id from keys, or nil

Package: openid-key.
Source: openid-key.lisp.

Function: get-openid-keys (issuer &key cached-keys proxy retry-times retry-interval) ¶

Get JWKs from ISSUER, or nil

CACHED-KEYS — an openid-keys for previous returned value, or nil. PROXY — a string for HTTP request proxy uri, or nil.

Package: openid-key.
Source: openid-key.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.2 Structures

Structure: openid-keys ¶

Package

openid-key.

Source

openid-key.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: issuer ¶

Readers: openid-keys-issuer.
Writers: (setf openid-keys-issuer).

Slot: jwks-expires ¶

Readers: openid-keys-jwks-expires.
Writers: (setf openid-keys-jwks-expires).

Slot: keys ¶

Readers: openid-keys-keys.
Writers: (setf openid-keys-keys).

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

6.2 Internals

Ordinary functions
Structures

Next: Structures, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Ordinary functions

Function: b64-integer (s) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: config-endpoint (endpoint) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: copy-openid-key (instance) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: copy-openid-keys (instance) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: get-expires (headers) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: issuer-endpoint (issuer) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: jwk-key (jwk) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: make-openid-key (&key kty use alg kid key) ¶

Package: openid-key.
Source: openid-key.lisp.

Function: make-openid-keys (&key issuer jwks-expires keys) ¶

Package: openid-key.
Source: openid-key.lisp.

Reader: openid-key-alg (instance) ¶

Writer: (setf openid-key-alg) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: alg.

Reader: openid-key-key (instance) ¶

Writer: (setf openid-key-key) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: key.

Reader: openid-key-kid (instance) ¶

Writer: (setf openid-key-kid) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: kid.

Reader: openid-key-kty (instance) ¶

Writer: (setf openid-key-kty) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: kty.

Function: openid-key-p (object) ¶

Package: openid-key.
Source: openid-key.lisp.

Reader: openid-key-use (instance) ¶

Writer: (setf openid-key-use) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: use.

Reader: openid-keys-issuer (instance) ¶

Writer: (setf openid-keys-issuer) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: issuer.

Reader: openid-keys-jwks-expires (instance) ¶

Writer: (setf openid-keys-jwks-expires) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: jwks-expires.

Reader: openid-keys-keys (instance) ¶

Writer: (setf openid-keys-keys) (instance) ¶

Package: openid-key.
Source: openid-key.lisp.
Target Slot: keys.

Function: openid-keys-p (object) ¶

Package: openid-key.
Source: openid-key.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.2 Structures

Structure: openid-key ¶

Package

openid-key.

Source

openid-key.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: kty ¶

Readers: openid-key-kty.
Writers: (setf openid-key-kty).

Slot: use ¶

Readers: openid-key-use.
Writers: (setf openid-key-use).

Slot: alg ¶

Readers: openid-key-alg.
Writers: (setf openid-key-alg).

Slot: kid ¶

Readers: openid-key-kid.
Writers: (setf openid-key-kid).

Slot: key ¶

Readers: openid-key-key.
Writers: (setf openid-key-key).

Previous: Definitions, Up: The openid-key Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( B C F G I J M O

	Index Entry	Section

(
	`(setf openid-key-alg)`:	Private ordinary functions
	`(setf openid-key-key)`:	Private ordinary functions
	`(setf openid-key-kid)`:	Private ordinary functions
	`(setf openid-key-kty)`:	Private ordinary functions
	`(setf openid-key-use)`:	Private ordinary functions
	`(setf openid-keys-issuer)`:	Private ordinary functions
	`(setf openid-keys-jwks-expires)`:	Private ordinary functions
	`(setf openid-keys-keys)`:	Private ordinary functions

B
	`b64-integer`:	Private ordinary functions

C
	`config-endpoint`:	Private ordinary functions
	`copy-openid-key`:	Private ordinary functions
	`copy-openid-keys`:	Private ordinary functions

F
	`find-openid-key`:	Public ordinary functions
	`Function, (setf openid-key-alg)`:	Private ordinary functions
	`Function, (setf openid-key-key)`:	Private ordinary functions
	`Function, (setf openid-key-kid)`:	Private ordinary functions
	`Function, (setf openid-key-kty)`:	Private ordinary functions
	`Function, (setf openid-key-use)`:	Private ordinary functions
	`Function, (setf openid-keys-issuer)`:	Private ordinary functions
	`Function, (setf openid-keys-jwks-expires)`:	Private ordinary functions
	`Function, (setf openid-keys-keys)`:	Private ordinary functions
	`Function, b64-integer`:	Private ordinary functions
	`Function, config-endpoint`:	Private ordinary functions
	`Function, copy-openid-key`:	Private ordinary functions
	`Function, copy-openid-keys`:	Private ordinary functions
	`Function, find-openid-key`:	Public ordinary functions
	`Function, get-expires`:	Private ordinary functions
	`Function, get-openid-keys`:	Public ordinary functions
	`Function, issuer-endpoint`:	Private ordinary functions
	`Function, jwk-key`:	Private ordinary functions
	`Function, make-openid-key`:	Private ordinary functions
	`Function, make-openid-keys`:	Private ordinary functions
	`Function, openid-key-alg`:	Private ordinary functions
	`Function, openid-key-key`:	Private ordinary functions
	`Function, openid-key-kid`:	Private ordinary functions
	`Function, openid-key-kty`:	Private ordinary functions
	`Function, openid-key-p`:	Private ordinary functions
	`Function, openid-key-use`:	Private ordinary functions
	`Function, openid-keys-issuer`:	Private ordinary functions
	`Function, openid-keys-jwks-expires`:	Private ordinary functions
	`Function, openid-keys-keys`:	Private ordinary functions
	`Function, openid-keys-p`:	Private ordinary functions

G
	`get-expires`:	Private ordinary functions
	`get-openid-keys`:	Public ordinary functions

I
	`issuer-endpoint`:	Private ordinary functions

J
	`jwk-key`:	Private ordinary functions

M
	`make-openid-key`:	Private ordinary functions
	`make-openid-keys`:	Private ordinary functions

O
	`openid-key-alg`:	Private ordinary functions
	`openid-key-key`:	Private ordinary functions
	`openid-key-kid`:	Private ordinary functions
	`openid-key-kty`:	Private ordinary functions
	`openid-key-p`:	Private ordinary functions
	`openid-key-use`:	Private ordinary functions
	`openid-keys-issuer`:	Private ordinary functions
	`openid-keys-jwks-expires`:	Private ordinary functions
	`openid-keys-keys`:	Private ordinary functions
	`openid-keys-p`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	A I J K S U

	Index Entry	Section

A
	`alg`:	Private structures

I
	`issuer`:	Public structures

J
	`jwks-expires`:	Public structures

K
	`key`:	Private structures
	`keys`:	Public structures
	`kid`:	Private structures
	`kty`:	Private structures

S
	`Slot, alg`:	Private structures
	`Slot, issuer`:	Public structures
	`Slot, jwks-expires`:	Public structures
	`Slot, key`:	Private structures
	`Slot, keys`:	Public structures
	`Slot, kid`:	Private structures
	`Slot, kty`:	Private structures
	`Slot, use`:	Private structures

U
	`use`:	Private structures

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

A.4 Data types

Jump to:	F M O P S

	Index Entry	Section

F
	`File, openid-key.asd`:	The openid-key/openid-key․asd file
	`File, openid-key.lisp`:	The openid-key/src/openid-key․lisp file

M
	`Module, src`:	The openid-key/src module

O
	`openid-key`:	The openid-key system
	`openid-key`:	The openid-key package
	`openid-key`:	Private structures
	`openid-key.asd`:	The openid-key/openid-key․asd file
	`openid-key.lisp`:	The openid-key/src/openid-key․lisp file
	`openid-keys`:	Public structures

P
	`Package, openid-key`:	The openid-key package

S
	`src`:	The openid-key/src module
	`Structure, openid-key`:	Private structures
	`Structure, openid-keys`:	Public structures
	`System, openid-key`:	The openid-key system

The openid-key Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 openid-key

3 Modules

3.1 openid-key/src

4 Files

4.1 Lisp

4.1.1 openid-key/openid-key.asd

4.1.2 openid-key/src/openid-key.lisp

5 Packages

5.1 openid-key

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.1.2 Structures

6.2 Internals

6.2.1 Ordinary functions

6.2.2 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `openid-key`

3.1 `openid-key/src`

4.1.1 `openid-key/openid-key.asd`

4.1.2 `openid-key/src/openid-key.lisp`

5.1 `openid-key`