The cl-openid Reference Manual

Table of Contents

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

The cl-openid Reference Manual

This is the cl-openid Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:53:35 2018 GMT+0.


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

1 Introduction

Home page and issue tracker: http://trac.common-lisp.net/cl-openid/

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 cl-openid

Maintainer

Maciej Pasternacki

Author

Maciej Pasternacki

License

LLGPL, see http://opensource.franz.com/preamble.html for details

Description

cl-openid

Version

0.1

Dependencies
Source

cl-openid.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 cl-openid/src

Parent

cl-openid (system)

Location

src/

Components

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 cl-openid.asd

Location

cl-openid.asd

Systems

cl-openid (system)

Packages

cl-openid.system


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

4.1.2 cl-openid/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-openid


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

4.1.3 cl-openid/src/shared.lisp

Dependencies
Parent

src (module)

Location

src/shared.lisp

Internal Definitions

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

4.1.4 cl-openid/src/message.lisp

Dependencies
Parent

src (module)

Location

src/message.lisp

Exported Definitions
Internal Definitions

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

4.1.5 cl-openid/src/association.lisp

Dependencies
Parent

src (module)

Location

src/association.lisp

Internal Definitions

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

4.1.6 cl-openid/src/authproc.lisp

Dependencies
Parent

src (module)

Location

src/authproc.lisp

Exported Definitions
Internal Definitions

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

4.1.7 cl-openid/src/relying-party.lisp

Dependencies
Parent

src (module)

Location

src/relying-party.lisp

Exported Definitions
Internal Definitions

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

4.1.8 cl-openid/src/provider.lisp

Dependencies
Parent

src (module)

Location

src/provider.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 cl-openid.system

Source

cl-openid.asd

Use List

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

5.2 cl-openid

Source

package.lisp (file)

Use List
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 Constants

Constant: +authproc-handle-parameter+

Name of HTTP GET parameter, sent in return_to URI, which contains AUTH-PROCESS object unique handle.

Package

cl-openid

Source

relying-party.lisp (file)

Constant: +indirect-response-code+

HTTP code recommented to use for indirect responses sent via HTTP redirect.

Package

cl-openid

Source

provider.lisp (file)


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

6.1.2 Macros

Macro: in-ns MESSAGE &optional NAMESPACE

Add openid.namespace NAMESPACE to MESSAGE.

Package

cl-openid

Source

message.lisp (file)


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

6.1.3 Functions

Function: auth-process-p OBJECT
Package

cl-openid

Source

authproc.lisp (file)

Function: auth-request-realm AUTH-REQUEST-MESSAGE

Returns the realm of the OpenID authentication request AUTH-REQUEST-MESSAGE.

Package

cl-openid

Source

message.lisp (file)

Function: cancel-response-uri OP AUTH-REQUEST-MESSAGE

Returns the URI of the Relying Party to redirect the user’s browser to. The URI parameters tell the Relying Party that the authentication failed. AUTH-REQUEST-MESSAGE should be the oritinal OpenID authentication request message that was received from the Relying Party previously and passed to the HANDLE-CHECKID-SETUP.

Package

cl-openid

Source

provider.lisp (file)

Function: claimed-id INSTANCE
Function: (setf claimed-id) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: copy-message MESSAGE &rest PARAMETERS

Create a copy of MESSAGE, updating PARAMETERS provided as keyword parameters.

If MESSAGE already includes provided key, new value is used in the result; if a key is new, the field will be appended to result message. PARAMETERS are interpreted as by MAKE-MESSAGE function.

Package

cl-openid

Source

message.lisp (file)

Function: handle-indirect-response RP MESSAGE REQUEST-URI &optional AUTHPROC

Handle indirect response MESSAGE for RP, coming at REQUEST-URI, concerning AUTHPROC.

AUTHPROC can be a literal AUTH-PROCESS object, or a string (unique
authproc handle, sent earlier by RP). When AUTHPROC is NIL or not
supplied, its handle is taken from MESSAGE.

Returns claimed ID URI on success, NIL on failure.
As second value, always returns AUTH-PROCESS object.

Package

cl-openid

Source

relying-party.lisp (file)

Function: handle-openid-provider-request OP MESSAGE &key ALLOW-UNENCRYPTED-ASSOCIATION-P &aux V1-COMPAT

Handle request MESSAGE for OpenID Provider instance OP.

ALLOW-UNENCRYPTED-ASSOCIATION-P specifies whether it is allowable
to use unencrypted association method. Set it to NIL unless your
OP endopoint uses HTTPS. See OpenID Authentication 2.0 - Final, section 8.4.1. No-Encryption Association Sessions (http://openid.net/specs/openid-authentication-2_0.html#assoc_sess_types).

Returns two values: the first is body, and the second is an HTTP status code.

On HTTP redirections (the second value between 300 and 399 inclusive), the primary returned value will be an URI to redirect the user to.

Package

cl-openid

Source

provider.lisp (file)

Function: immediate-p INSTANCE
Function: (setf immediate-p) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: initiate-authentication RP GIVEN-ID &key IMMEDIATE-P EXTRA-PARAMETERS &aux AUTHPROC HANDLE

Initiate authentication process by relying party RP for identifier GIVEN-ID received from user.

If IMMEDIATE-P is true, initiates immediate authentication process.

The EXTRA-PARAMETERS is an optional key-value list to be added to the authentication request message. The list format is the same as for the MAKE-MESSAGE function. This parameter is needed for OpenID extensions, for example OAuth or Attribute Exchange.

Returns multiple values:
- the URI to redirect the user’s browser to;
- Unique handle (string) identifying the started authentication process;
- the AUTH-PROCESS structure identified by the handle.

The latter two values are useful if the client code needs to track the process.

Package

cl-openid

Source

relying-party.lisp (file)

Function: message-field MESSAGE FIELD-NAME

get value of FIELD-NAME field from MESSAGE.

Package

cl-openid

Source

message.lisp (file)

Function: message-v2-p MESSAGE

True if MESSAGE is an OpenID v2 message (namespace check).

Package

cl-openid

Source

message.lisp (file)

Function: op-local-id INSTANCE
Function: (setf op-local-id) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: protocol-version AUTH-PROCESS

Protocol version of an authentication process, as a cons (MAJOR . MINOR).

Package

cl-openid

Source

authproc.lisp (file)

Writer

(setf protocol-version) (function)

Function: (setf protocol-version) NEW-VALUE AUTH-PROCESS
Package

cl-openid

Source

authproc.lisp (file)

Reader

protocol-version (function)

Function: protocol-version-major INSTANCE
Function: (setf protocol-version-major) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: protocol-version-minor INSTANCE
Function: (setf protocol-version-minor) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: provider-endpoint-uri INSTANCE
Function: (setf provider-endpoint-uri) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: return-to INSTANCE
Function: (setf return-to) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: successful-response-uri OP AUTH-REQUEST-MESSAGE

Returns the URI of the Relying Party to redirect the user’s browser to. The URI parameters tell the Relying Party that the authentication was successful. AUTH-REQUEST-MESSAGE should be the oritinal OpenID authentication request message that was received from the Relying Party previously and passed to the HANDLE-CHECKID-SETUP.

Package

cl-openid

Source

provider.lisp (file)

Function: timestamp INSTANCE
Function: (setf timestamp) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: xrds-location INSTANCE
Function: (setf xrds-location) VALUE INSTANCE
Package

cl-openid

Source

authproc.lisp (file)


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

6.1.4 Generic functions

Generic Function: authproc CONDITION
Package

cl-openid

Methods
Method: authproc (CONDITION openid-assertion-error)
Source

relying-party.lisp (file)

Generic Function: code CONDITION
Package

cl-openid

Methods
Method: code (CONDITION openid-assertion-error)
Source

relying-party.lisp (file)

Generic Function: endpoint-uri OBJECT
Generic Function: (setf endpoint-uri) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: endpoint-uri (OPENID-PROVIDER openid-provider)
Method: (setf endpoint-uri) NEW-VALUE (OPENID-PROVIDER openid-provider)

Provider endpoint URI

Source

provider.lisp (file)

Generic Function: handle-checkid-immediate OP MESSAGE

Handles checkid_immediate requests.

This generic should be specialized on concrete Provider classes to perform immediate login checks on MESSAGE. It should return at once, either true value (to indicate successful login), or NIL (to indicate immediate login failure).

Package

cl-openid

Source

provider.lisp (file)

Methods
Method: handle-checkid-immediate OP MESSAGE

Always fail.

Generic Function: handle-checkid-setup OP MESSAGE

Handles checkid_setup requests.

This generic should be specialized on concrete Provider classes to
perform login checks with user dialogue, that would (possibly
after some HTTP request-response cycles) end by redirecting the
user’s browser either to SUCCESSFUL-RESPONSE-URI, or to
CANCEL-RESPONSE-URI.

This generic is called by HANDLE-OPENID-PROVIDER-REQUEST, and
the values returned by this function are then returned by HANDLE-OPENID-PROVIDER-REQUEST. I.e. it must return two values:
response "body" and HTTP status code. That way HANDLE-CHECKID-SETUP
can either redirect user’s browser somewhere, or just show him
something. (With hunchentoot, HUNCHNTOOT:REDIRECT
may also be used, which is a non-local transfer control).

Default method just returns (VALUES (CANSEL-RESPONSE-URI ...) +INDIRECT-RESPONSE-CODE+).

Package

cl-openid

Source

provider.lisp (file)

Methods
Method: handle-checkid-setup OP MESSAGE
Generic Function: message CONDITION
Package

cl-openid

Methods
Method: message (CONDITION openid-assertion-error)
Source

relying-party.lisp (file)

Method: message (CONDITION openid-request-error)
Source

message.lisp (file)

Generic Function: realm OBJECT
Generic Function: (setf realm) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: realm (RELYING-PARTY relying-party)
Method: (setf realm) NEW-VALUE (RELYING-PARTY relying-party)

Relying Party realm.

Source

relying-party.lisp (file)

Generic Function: reason CONDITION
Package

cl-openid

Methods
Method: reason (CONDITION indirect-error)
Source

provider.lisp (file)

Method: reason (CONDITION openid-assertion-error)
Source

relying-party.lisp (file)

Method: reason (CONDITION openid-request-error)
Source

message.lisp (file)

Generic Function: root-uri OBJECT
Generic Function: (setf root-uri) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: root-uri (RELYING-PARTY relying-party)
Method: (setf root-uri) NEW-VALUE (RELYING-PARTY relying-party)

Root URI address of the Relying Party instance.

Used to generate return_to redirections.

Source

relying-party.lisp (file)


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

6.1.5 Conditions

Condition: openid-assertion-error ()

Error signaled by RP when indirect response cannot be verified correctly.

Package

cl-openid

Source

relying-party.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: code

Keyword code of error.

Possible values are
- :SERVER-ERROR (received response is an erroor message),
- :SETUP-NEEDED (negative response to immediate request),
- :INVALID-RETURN-TO (request doesn’t match previously sent openid.return_to),
- :INVALID-NAMESPACE (invalid openid.ns in received message),
- :INVALID-ENDPOINT (endpoint specified in assertion does not match previously discovered information),
- :INVALID-CLAIMED-ID (received claimed_id differs from specified previously, discovery for received claimed ID returns other endpoint), - :INVALID-NONCE (repeated openid.nonce),
- :INVALID-SIGNATURE (signature verification failed),
- :INVALID-SIGNED-FIELDS (not all fields that need to be signed, were signed).

Initargs

:code

Readers

code (generic function)

Slot: reason

Textual description of error.

Initargs

:reason

Readers

reason (generic function)

Slot: authproc

AUTH-PROCESS structure that was being verified.

Initargs

:authproc

Readers

authproc (generic function)

Slot: message

Received message.

Initargs

:message

Readers

message (generic function)


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

6.1.6 Structures

Structure: auth-process ()

Data structure gathering information about an ongoing authentication process.

Package

cl-openid

Source

authproc.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: protocol-version-major
Type

(unsigned-byte 8)

Initform

2

Readers

protocol-version-major (function)

Writers

(setf protocol-version-major) (function)

Slot: protocol-version-minor
Type

(unsigned-byte 8)

Initform

0

Readers

protocol-version-minor (function)

Writers

(setf protocol-version-minor) (function)

Slot: claimed-id
Type

puri:uri

Readers

claimed-id (function)

Writers

(setf claimed-id) (function)

Slot: op-local-id
Type

(or puri:uri null)

Readers

op-local-id (function)

Writers

(setf op-local-id) (function)

Slot: immediate-p
Readers

immediate-p (function)

Writers

(setf immediate-p) (function)

Slot: return-to
Type

(or puri:uri null)

Readers

return-to (function)

Writers

(setf return-to) (function)

Slot: xrds-location
Type

(or puri:uri null)

Readers

xrds-location (function)

Writers

(setf xrds-location) (function)

Slot: provider-endpoint-uri
Type

(or puri:uri null)

Readers

provider-endpoint-uri (function)

Writers

(setf provider-endpoint-uri) (function)

Slot: timestamp
Type

(or integer null)

Readers

timestamp (function)

Writers

(setf timestamp) (function)


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

6.1.7 Classes

Class: openid-provider ()

OpenID Provider server abstract class.

This class should be subclassed, and specialized methods should be provided at least for HANDLE-CHECKID-SETUP (preferably also for HANDLE-CHECKID-IMMEDIATE).

Package

cl-openid

Source

provider.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: endpoint-uri

Provider endpoint URI

Initargs

:endpoint-uri

Readers

endpoint-uri (generic function)

Writers

(setf endpoint-uri) (generic function)

Slot: associations

OP’s associations.

Initargs

:associations

Initform

(make-hash-table :test (function equal))

Readers

associations (generic function)

Writers

(setf associations) (generic function)

Slot: associations-lock
Initargs

:associations-lock

Initform

(bordeaux-threads:make-lock)

Readers

associations-lock (generic function)

Writers

(setf associations-lock) (generic function)

Class: relying-party ()

Relying Party server class.

Package

cl-openid

Source

relying-party.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: root-uri

Root URI address of the Relying Party instance.

Used to generate return_to redirections.

Initargs

:root-uri

Readers

root-uri (generic function)

Writers

(setf root-uri) (generic function)

Slot: realm

Relying Party realm.

Initargs

:realm

Readers

realm (generic function)

Writers

(setf realm) (generic function)

Slot: associations

Associations made by RP.

Initargs

:associations

Initform

(make-hash-table :test (function equalp))

Readers

associations (generic function)

Writers

(setf associations) (generic function)

Slot: associations-lock
Initargs

:associations-lock

Initform

(bordeaux-threads:make-lock)

Readers

associations-lock (generic function)

Writers

(setf associations-lock) (generic function)

Slot: authprocs

Authenticaction processes currently handled by RP.

Initargs

:authprocs

Initform

(make-hash-table :test (function equal))

Readers

authprocs (generic function)

Writers

(setf authprocs) (generic function)

Slot: authproc-timeout

Number of seconds after which an AUTH-PROCESS is considered timed out and is deleted from AUTHPROCS.

Initargs

:authproc-timeout

Initform

3600

Readers

authproc-timeout (generic function)

Writers

(setf authproc-timeout) (generic function)

Slot: authprocs-lock
Initargs

:authprocs-lock

Initform

(bordeaux-threads:make-lock)

Readers

authprocs-lock (generic function)

Writers

(setf authprocs-lock) (generic function)

Slot: nonces

A list of openid.nonce response parameters to avoid duplicates.

Initargs

:nonces

Readers

nonces (generic function)

Writers

(setf nonces) (generic function)

Slot: nonce-timeout

Number of seconds after which nonce is considered timed out.

Initargs

:nonce-timeout

Initform

3600

Readers

nonce-timeout (generic function)

Writers

(setf nonce-timeout) (generic function)

Slot: nonces-lock
Initargs

:nonces-lock

Initform

(bordeaux-threads:make-lock)

Readers

nonces-lock (generic function)

Writers

(setf nonces-lock) (generic function)


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

6.2 Internal definitions


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

6.2.1 Constants

Constant: +cancel-response-message+
Package

cl-openid

Source

provider.lisp (file)

Constant: +dh-generator+

Default generator value for Diffie-Hellman key exchange.

Package

cl-openid

Source

association.lisp (file)

Constant: +dh-prime+

This is a confirmed-prime number, used as the default modulus for Diffie-Hellman Key Exchange.

Package

cl-openid

Source

association.lisp (file)

Constant: +entities+

Alist of HTML entities to be unquoted.

Package

cl-openid

Source

authproc.lisp (file)

Constant: +openid2-namespace+

Namespace URI for OpenID 2.0 messages.

Package

cl-openid

Source

message.lisp (file)

Constant: +openid2-ns-cons+

Helper constant pair for constructing messages.

Package

cl-openid

Source

message.lisp (file)

Constant: +protocol-versions+

OpenID protocol versions for XRDS service type URIs

Package

cl-openid

Source

authproc.lisp (file)

Constant: +setup-needed-response-message+
Package

cl-openid

Source

provider.lisp (file)


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

6.2.2 Special variables

Special Variable: *association-handle-counter*

Counter for unique association handle generation

Package

cl-openid

Source

association.lisp (file)

Special Variable: *auth-handle-counter*

Counter for unique association handle generation

Package

cl-openid

Source

relying-party.lisp (file)

Special Variable: *default-association-timeout*

Default association timeout, in seconds

Package

cl-openid

Source

association.lisp (file)

Special Variable: *nonce-counter*

Counter for nonce generation

Package

cl-openid

Source

provider.lisp (file)


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

6.2.3 Macros

Macro: define-constant NAME VALUE &rest OPTIONS

Do a DEFCONSTANT, but do not attempt to redefine if already bound.

Package

cl-openid

Source

shared.lisp (file)

Macro: string-case KEYFORM &body CLAUSES

Like CASE, but for a string KEYFORM.

Package

cl-openid

Source

shared.lisp (file)

Macro: with-indirect-error-handler &body BODY

Handle INDIRECT-ERROR in BODY.

When INDIRECT-ERROR is signaled, immediately return indirect error response.

Package

cl-openid

Source

provider.lisp (file)


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

6.2.4 Functions

Function: %make-association &key (EXPIRES EXPIRES) (HANDLE HANDLE) (MAC MAC) (HMAC-DIGEST HMAC-DIGEST)
Package

cl-openid

Source

association.lisp (file)

Function: %make-auth-process &key (PROTOCOL-VERSION-MAJOR PROTOCOL-VERSION-MAJOR) (PROTOCOL-VERSION-MINOR PROTOCOL-VERSION-MINOR) (CLAIMED-ID CLAIMED-ID) (OP-LOCAL-ID OP-LOCAL-ID) (IMMEDIATE-P IMMEDIATE-P) (RETURN-TO RETURN-TO) (XRDS-LOCATION XRDS-LOCATION) (PROVIDER-ENDPOINT-URI PROVIDER-ENDPOINT-URI) (TIMESTAMP TIMESTAMP)
Package

cl-openid

Source

authproc.lisp (file)

Function: aget KEY ALIST

Get a CDR of an (ASSOC KEY ALIST).

Sequence (e.g. string) keys are searched with :TEST #’EQUAL.

Package

cl-openid

Source

shared.lisp (file)

Function: alist-to-url-encoded-string ALIST EXTERNAL-FORMAT

ALIST is supposed to be an alist of name/value pairs where both names and values are strings (or, for values, NIL). This function returns a string where this list is represented as for the content type ‘application/x-www-form-urlencoded’, i.e. the values are URL-encoded using the external format EXTERNAL-FORMAT, the pairs are joined with a #\& character, and each name is separated from its value with a #\= character. If the value is NIL, no #\= is used.

Package

cl-openid

Source

shared.lisp (file)

Function: ap-association RP AUTHPROC
Package

cl-openid

Source

relying-party.lisp (file)

Function: associate ENDPOINT &key V1 ASSOC-TYPE SESSION-TYPE &aux XA
Package

cl-openid

Source

association.lisp (file)

Function: association RP ENDPOINT &optional V1
Package

cl-openid

Source

relying-party.lisp (file)

Function: association-by-handle RP HANDLE
Package

cl-openid

Source

relying-party.lisp (file)

Function: association-expires INSTANCE
Function: (setf association-expires) VALUE INSTANCE
Package

cl-openid

Source

association.lisp (file)

Function: association-handle INSTANCE
Function: (setf association-handle) VALUE INSTANCE
Package

cl-openid

Source

association.lisp (file)

Function: association-hmac-digest INSTANCE
Function: (setf association-hmac-digest) VALUE INSTANCE
Package

cl-openid

Source

association.lisp (file)

Function: association-mac INSTANCE
Function: (setf association-mac) VALUE INSTANCE
Package

cl-openid

Source

association.lisp (file)

Function: association-p OBJECT
Package

cl-openid

Source

association.lisp (file)

Function: authproc-by-handle RP HANDLE
Package

cl-openid

Source

relying-party.lisp (file)

Function: base64-btwoc I

Return two’s complement binary string representing integer I, as Base64-encoded string.

Package

cl-openid

Source

shared.lisp (file)

Function: btwoc I &aux OCTETS

Return two’s complement binary string representing integer I, as an octet vector.

Package

cl-openid

Source

shared.lisp (file)

Function: check-discovery-postcondition AUTHPROC
Package

cl-openid

Source

authproc.lisp (file)

Function: check-realm REALM URI

Check URI against REALM.

Package

cl-openid

Source

provider.lisp (file)

Function: check-signature ASSOCIATION MESSAGE
Package

cl-openid

Source

association.lisp (file)

Function: copy-association INSTANCE
Package

cl-openid

Source

association.lisp (file)

Function: copy-auth-process INSTANCE
Package

cl-openid

Source

authproc.lisp (file)

Function: dh-encrypt/decrypt-key DIGEST GENERATOR PRIME PUBLIC PRIVATE KEY

Perform Diffie-Hellman key exchange.

Package

cl-openid

Source

association.lisp (file)

Function: direct-error-response ERR &key CONTACT REFERENCE MESSAGE

Return error direct response (key-value-encoded error message as body, 400 Error code as second value).

Package

cl-openid

Source

provider.lisp (file)

Function: direct-request URI MESSAGE

Send a direct request to URI, sending MESSAGE alist.

Package

cl-openid

Source

message.lisp (file)

Function: direct-response MESSAGE

Return direct response (key-value-encoded MESSAGE as body, no second value).

Package

cl-openid

Source

provider.lisp (file)

Function: discover ID &aux AUTHPROC REQUEST-URI *TEXT-CONTENT-TYPES*

Perform discovery on ID.

ID may be either an already initialized AUTH-PROCESS structure, or user-given ID string.

Signals an OPENID-DISCOVERY-ERROR if the discovery was unsuccessful, i.e. when the discovery URI specified by ID does not contain the needed OpenID discovery information. May also signal other errors, in case of network problems, or if the URI is not available, etc.

Package

cl-openid

Source

authproc.lisp (file)

Function: encode-kv MESSAGE

Encode MESSAGE alist as key-value form octet vector

Package

cl-openid

Source

message.lisp (file)

Function: ensure-integer VAL

For VAL being an integer, a Base64-encoded string representing integer, or an octet vector representing integer, return its integer value.

Package

cl-openid

Source

shared.lisp (file)

Function: ensure-trailing-slash PATH

Add trailing slash to PATH if it’s not already there.

Package

cl-openid

Source

shared.lisp (file)

Function: ensure-vector VAL

For VAL being an integer, a Base64-encoded string representing integer, or an octet vector representing integer, return it as an octet vector.

Package

cl-openid

Source

shared.lisp (file)

Function: ensure-vector-length VEC LEN

Shorten or enlarge vector VEC so that it has length LEN.

If (= (LENGTH VEC) LEN), returns VEC. Otherwise, either pads with zeroes on the left, or removes a number of leftmost elements.

Package

cl-openid

Source

shared.lisp (file)

Function: error-response-message ERR &key CONTACT REFERENCE MESSAGE
Package

cl-openid

Source

message.lisp (file)

Function: gc-associations SERVER &optional INVALIDATE-HANDLE &aux TIME

Garbage-collect timed out associations from SERVER.

INVALIDATE-HANDLE is a handle of association that needs to be collected regardless of validity. SERVER may be a RELYING-PARTY or OPENID-PROVIDER instance.

Package

cl-openid

Source

relying-party.lisp (file)

Function: gc-authprocs RP &aux TIME-LIMIT

Collect old auth-process objects from relying party RP.

Package

cl-openid

Source

relying-party.lisp (file)

Function: gc-nonces RP &aux TIME-LIMIT
Package

cl-openid

Source

relying-party.lisp (file)

Function: indirect-message-uri ENDPOINT MESSAGE &aux URI

Return URI to send indirect message MESSAGE to endpoint URI ENDPOINT.

Usable for both indirect requests and responses.

Package

cl-openid

Source

message.lisp (file)

Function: indirect-response RETURN-TO MESSAGE

Return indirect response (URI as body +INDIRECT-RESPONSE-CODE+ as the second value).

Package

cl-openid

Source

provider.lisp (file)

Function: make-association &key HANDLE EXPIRES-IN EXPIRES-AT ASSOCIATION-TYPE HMAC-DIGEST MAC

Make new association structure, DWIM included.

- HANDLE should be the new association handle; if none is provided, new one is generated.
- EXPIRES-IN is the timeout of the handle; alternatively, EXPIRES-AT is the universal-time when association times out.
- ASSOCIATION-TYPE is the OpenID association type (string); alternatively, HMAC-DIGEST is an Ironclad digest name (a keyword) used for signature HMAC checks.
- MAC is the literal, unencrypted MAC key.

Package

cl-openid

Source

association.lisp (file)

Function: make-auth-process GIVEN-ID

Initialize new AUTH-PROCESS structure from a user-given identifier GIVEN-ID (string).

An XRDS location for Yadis discovery discovered by a HEAD request may
be included in returned structure.

Package

cl-openid

Source

authproc.lisp (file)

Function: maybe-uri U

Return (URI U), unless U is NIL.

Package

cl-openid

Source

shared.lisp (file)

Function: message-field-string VALUE

Format VALUE as a string for protocol message.

Package

cl-openid

Source

message.lisp (file)

Function: n-remove-entities STR &optional ENTITIES

Remove HTML entities from STR, destructively.

Package

cl-openid

Source

authproc.lisp (file)

Function: new-association-handle ()

Return new unique association handle as string

Package

cl-openid

Source

association.lisp (file)

Function: new-authproc-handle ()

Return new unique authentication handle as string

Package

cl-openid

Source

relying-party.lisp (file)

Function: new-uri U

Return U as new URI object.

If U is already an URI object, return a copy; otherwise, return (URI U).

Package

cl-openid

Source

shared.lisp (file)

Function: nonce ()
Package

cl-openid

Source

provider.lisp (file)

Function: nonce-universal-time NONCE
Package

cl-openid

Source

relying-party.lisp (file)

Function: openid-association-error FORMAT-CONTROL &rest FORMAT-ARGUMENTS
Package

cl-openid

Source

association.lisp (file)

Function: openid-discovery-error FORMAT-CONTROL &rest FORMAT-ARGUMENTS
Package

cl-openid

Source

authproc.lisp (file)

Function: parse-kv ARRAY

Parse key-value form message passed as an octet vector into parameter alist.

Package

cl-openid

Source

message.lisp (file)

Function: perform-html-discovery AUTHPROC BODY &aux EP OPLOC EP.1 OPLOC.1 XRDS
Package

cl-openid

Source

authproc.lisp (file)

Function: perform-xrds-discovery AUTHPROC BODY &aux PARSED PRIO ENDPOINT OPLOCAL V1PRIO V1ENDPOINT V1OPLOCAL V1TYPE
Package

cl-openid

Source

authproc.lisp (file)

Function: remove-dot-segments PARSED-PATH

Remove . and .. from parsed URI path, to correctly identify same paths and prevent URI traversal attacks.

Package

cl-openid

Source

authproc.lisp (file)

Function: request-authentication-uri AUTHPROC &key REALM IMMEDIATE-P ASSOCIATION EXTRA-PARAMETERS

URI for an authentication request for AUTHPROC

Package

cl-openid

Source

authproc.lisp (file)

Function: session-digest-type SESSION-TYPE
Package

cl-openid

Source

association.lisp (file)

Function: setup-needed-response OP MESSAGE

Send setup_needed (immediate authentication failure) response to MESSAGE from OP.

Package

cl-openid

Source

provider.lisp (file)

Function: setup-needed-response-message OP MESSAGE
Package

cl-openid

Source

provider.lisp (file)

Function: signal-indirect-error MESSAGE REASON &rest ARGS

Signal INDIRECT-ERROR condition for MESSAGE, effectively returning indirect error reply from WITH-INDIRECT-ERROR-HANDLER.

REASON is textual error message format string, with ARGS being its
arguments.

Package

cl-openid

Source

provider.lisp (file)

Function: signature ASSOCIATION MESSAGE &optional SIGNED

Calculate signature from MESSAGE using ASSOCIATION, return signature string.

Optional SIGNED parameter is a list of fields to sign, as strings,
with "openid" prefix stripped.

Package

cl-openid

Source

association.lisp (file)

Function: signed ASSOCIATION MESSAGE &optional SIGNED

Sign MESSAGE, using ASSOCIATION, return signed message.

Optional SIGNED parameter is a list of fields to sign, as strings, with "openid" prefix stripped.

Package

cl-openid

Source

association.lisp (file)

Function: successful-response-message OP MESSAGE
Package

cl-openid

Source

provider.lisp (file)

Function: user-setup-url OP MESSAGE

Returns the value to be passed in the openid.user_setup_url parameter of a response to a failed immediate authentication request. OP is the OpenID Provider. MESSAGE is the original authentication request. In case the MESSAGE is a request of OpenID version 2, returns NIL.

Package

cl-openid

Source

provider.lisp (file)


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

6.2.5 Generic functions

Generic Function: associations OBJECT
Generic Function: (setf associations) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: associations (OPENID-PROVIDER openid-provider)
Method: (setf associations) NEW-VALUE (OPENID-PROVIDER openid-provider)

OP’s associations.

Source

provider.lisp (file)

Method: associations (RELYING-PARTY relying-party)
Method: (setf associations) NEW-VALUE (RELYING-PARTY relying-party)

Associations made by RP.

Source

relying-party.lisp (file)

Generic Function: associations-lock OBJECT
Generic Function: (setf associations-lock) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: associations-lock (OPENID-PROVIDER openid-provider)

automatically generated reader method

Source

provider.lisp (file)

Method: (setf associations-lock) NEW-VALUE (OPENID-PROVIDER openid-provider)

automatically generated writer method

Source

provider.lisp (file)

Method: associations-lock (RELYING-PARTY relying-party)

automatically generated reader method

Source

relying-party.lisp (file)

Method: (setf associations-lock) NEW-VALUE (RELYING-PARTY relying-party)

automatically generated writer method

Source

relying-party.lisp (file)

Generic Function: authproc-timeout OBJECT
Generic Function: (setf authproc-timeout) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: authproc-timeout (RELYING-PARTY relying-party)
Method: (setf authproc-timeout) NEW-VALUE (RELYING-PARTY relying-party)

Number of seconds after which an AUTH-PROCESS is considered timed out and is deleted from AUTHPROCS.

Source

relying-party.lisp (file)

Generic Function: authprocs OBJECT
Generic Function: (setf authprocs) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: authprocs (RELYING-PARTY relying-party)
Method: (setf authprocs) NEW-VALUE (RELYING-PARTY relying-party)

Authenticaction processes currently handled by RP.

Source

relying-party.lisp (file)

Generic Function: authprocs-lock OBJECT
Generic Function: (setf authprocs-lock) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: authprocs-lock (RELYING-PARTY relying-party)

automatically generated reader method

Source

relying-party.lisp (file)

Method: (setf authprocs-lock) NEW-VALUE (RELYING-PARTY relying-party)

automatically generated writer method

Source

relying-party.lisp (file)

Generic Function: nonce-timeout OBJECT
Generic Function: (setf nonce-timeout) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: nonce-timeout (RELYING-PARTY relying-party)
Method: (setf nonce-timeout) NEW-VALUE (RELYING-PARTY relying-party)

Number of seconds after which nonce is considered timed out.

Source

relying-party.lisp (file)

Generic Function: nonces OBJECT
Generic Function: (setf nonces) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: nonces (RELYING-PARTY relying-party)
Method: (setf nonces) NEW-VALUE (RELYING-PARTY relying-party)

A list of openid.nonce response parameters to avoid duplicates.

Source

relying-party.lisp (file)

Generic Function: nonces-lock OBJECT
Generic Function: (setf nonces-lock) NEW-VALUE OBJECT
Package

cl-openid

Methods
Method: nonces-lock (RELYING-PARTY relying-party)

automatically generated reader method

Source

relying-party.lisp (file)

Method: (setf nonces-lock) NEW-VALUE (RELYING-PARTY relying-party)

automatically generated writer method

Source

relying-party.lisp (file)

Generic Function: return-to-uri CONDITION
Package

cl-openid

Methods
Method: return-to-uri (CONDITION indirect-error)
Source

provider.lisp (file)


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

6.2.6 Conditions

Condition: indirect-error ()

Error occured during OpenID chekid_setup or checkid_immediate handling.

This condition is handled by HANDLE-OPENID-PROVIDER-REQUEST and, if it occurs, indirect error response is directed to user.

Package

cl-openid

Source

provider.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: reason

Textual error description.

Initargs

:reason

Readers

reason (generic function)

Slot: return-to-uri

return_to address to direct indirect error message to.

Initargs

:return-to-uri

Initform

(quote nil)

Readers

return-to-uri (generic function)

Condition: openid-association-error ()
Package

cl-openid

Source

association.lisp (file)

Direct superclasses

simple-error (condition)

Condition: openid-discovery-error ()
Package

cl-openid

Source

authproc.lisp (file)

Direct superclasses

simple-error (condition)

Condition: openid-request-error ()
Package

cl-openid

Source

message.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: reason
Initargs

:reason

Readers

reason (generic function)

Slot: message
Initargs

:message

Readers

message (generic function)


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

6.2.7 Structures

Structure: association ()

An association between OP and RP.

Package

cl-openid

Source

association.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: expires
Type

integer

Readers

association-expires (function)

Writers

(setf association-expires) (function)

Slot: handle
Type

string

Readers

association-handle (function)

Writers

(setf association-handle) (function)

Slot: mac
Type

(simple-array (unsigned-byte 8) (*))

Readers

association-mac (function)

Writers

(setf association-mac) (function)

Slot: hmac-digest
Type

keyword

Readers

association-hmac-digest (function)

Writers

(setf association-hmac-digest) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-openid.asd: The cl-openid<dot>asd file
cl-openid/src: The cl-openid/src module
cl-openid/src/association.lisp: The cl-openid/src/association<dot>lisp file
cl-openid/src/authproc.lisp: The cl-openid/src/authproc<dot>lisp file
cl-openid/src/message.lisp: The cl-openid/src/message<dot>lisp file
cl-openid/src/package.lisp: The cl-openid/src/package<dot>lisp file
cl-openid/src/provider.lisp: The cl-openid/src/provider<dot>lisp file
cl-openid/src/relying-party.lisp: The cl-openid/src/relying-party<dot>lisp file
cl-openid/src/shared.lisp: The cl-openid/src/shared<dot>lisp file

F
File, Lisp, cl-openid.asd: The cl-openid<dot>asd file
File, Lisp, cl-openid/src/association.lisp: The cl-openid/src/association<dot>lisp file
File, Lisp, cl-openid/src/authproc.lisp: The cl-openid/src/authproc<dot>lisp file
File, Lisp, cl-openid/src/message.lisp: The cl-openid/src/message<dot>lisp file
File, Lisp, cl-openid/src/package.lisp: The cl-openid/src/package<dot>lisp file
File, Lisp, cl-openid/src/provider.lisp: The cl-openid/src/provider<dot>lisp file
File, Lisp, cl-openid/src/relying-party.lisp: The cl-openid/src/relying-party<dot>lisp file
File, Lisp, cl-openid/src/shared.lisp: The cl-openid/src/shared<dot>lisp file

L
Lisp File, cl-openid.asd: The cl-openid<dot>asd file
Lisp File, cl-openid/src/association.lisp: The cl-openid/src/association<dot>lisp file
Lisp File, cl-openid/src/authproc.lisp: The cl-openid/src/authproc<dot>lisp file
Lisp File, cl-openid/src/message.lisp: The cl-openid/src/message<dot>lisp file
Lisp File, cl-openid/src/package.lisp: The cl-openid/src/package<dot>lisp file
Lisp File, cl-openid/src/provider.lisp: The cl-openid/src/provider<dot>lisp file
Lisp File, cl-openid/src/relying-party.lisp: The cl-openid/src/relying-party<dot>lisp file
Lisp File, cl-openid/src/shared.lisp: The cl-openid/src/shared<dot>lisp file

M
Module, cl-openid/src: The cl-openid/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   M   N   O   P   R   S   T   U   W   X  
Index Entry  Section

%
%make-association: Internal functions
%make-auth-process: Internal functions

(
(setf association-expires): Internal functions
(setf association-handle): Internal functions
(setf association-hmac-digest): Internal functions
(setf association-mac): Internal functions
(setf associations): Internal generic functions
(setf associations): Internal generic functions
(setf associations): Internal generic functions
(setf associations-lock): Internal generic functions
(setf associations-lock): Internal generic functions
(setf associations-lock): Internal generic functions
(setf authproc-timeout): Internal generic functions
(setf authproc-timeout): Internal generic functions
(setf authprocs): Internal generic functions
(setf authprocs): Internal generic functions
(setf authprocs-lock): Internal generic functions
(setf authprocs-lock): Internal generic functions
(setf claimed-id): Exported functions
(setf endpoint-uri): Exported generic functions
(setf endpoint-uri): Exported generic functions
(setf immediate-p): Exported functions
(setf nonce-timeout): Internal generic functions
(setf nonce-timeout): Internal generic functions
(setf nonces): Internal generic functions
(setf nonces): Internal generic functions
(setf nonces-lock): Internal generic functions
(setf nonces-lock): Internal generic functions
(setf op-local-id): Exported functions
(setf protocol-version): Exported functions
(setf protocol-version-major): Exported functions
(setf protocol-version-minor): Exported functions
(setf provider-endpoint-uri): Exported functions
(setf realm): Exported generic functions
(setf realm): Exported generic functions
(setf return-to): Exported functions
(setf root-uri): Exported generic functions
(setf root-uri): Exported generic functions
(setf timestamp): Exported functions
(setf xrds-location): Exported functions

A
aget: Internal functions
alist-to-url-encoded-string: Internal functions
ap-association: Internal functions
associate: Internal functions
association: Internal functions
association-by-handle: Internal functions
association-expires: Internal functions
association-handle: Internal functions
association-hmac-digest: Internal functions
association-mac: Internal functions
association-p: Internal functions
associations: Internal generic functions
associations: Internal generic functions
associations: Internal generic functions
associations-lock: Internal generic functions
associations-lock: Internal generic functions
associations-lock: Internal generic functions
auth-process-p: Exported functions
auth-request-realm: Exported functions
authproc: Exported generic functions
authproc: Exported generic functions
authproc-by-handle: Internal functions
authproc-timeout: Internal generic functions
authproc-timeout: Internal generic functions
authprocs: Internal generic functions
authprocs: Internal generic functions
authprocs-lock: Internal generic functions
authprocs-lock: Internal generic functions

B
base64-btwoc: Internal functions
btwoc: Internal functions

C
cancel-response-uri: Exported functions
check-discovery-postcondition: Internal functions
check-realm: Internal functions
check-signature: Internal functions
claimed-id: Exported functions
code: Exported generic functions
code: Exported generic functions
copy-association: Internal functions
copy-auth-process: Internal functions
copy-message: Exported functions

D
define-constant: Internal macros
dh-encrypt/decrypt-key: Internal functions
direct-error-response: Internal functions
direct-request: Internal functions
direct-response: Internal functions
discover: Internal functions

E
encode-kv: Internal functions
endpoint-uri: Exported generic functions
endpoint-uri: Exported generic functions
ensure-integer: Internal functions
ensure-trailing-slash: Internal functions
ensure-vector: Internal functions
ensure-vector-length: Internal functions
error-response-message: Internal functions

F
Function, %make-association: Internal functions
Function, %make-auth-process: Internal functions
Function, (setf association-expires): Internal functions
Function, (setf association-handle): Internal functions
Function, (setf association-hmac-digest): Internal functions
Function, (setf association-mac): Internal functions
Function, (setf claimed-id): Exported functions
Function, (setf immediate-p): Exported functions
Function, (setf op-local-id): Exported functions
Function, (setf protocol-version): Exported functions
Function, (setf protocol-version-major): Exported functions
Function, (setf protocol-version-minor): Exported functions
Function, (setf provider-endpoint-uri): Exported functions
Function, (setf return-to): Exported functions
Function, (setf timestamp): Exported functions
Function, (setf xrds-location): Exported functions
Function, aget: Internal functions
Function, alist-to-url-encoded-string: Internal functions
Function, ap-association: Internal functions
Function, associate: Internal functions
Function, association: Internal functions
Function, association-by-handle: Internal functions
Function, association-expires: Internal functions
Function, association-handle: Internal functions
Function, association-hmac-digest: Internal functions
Function, association-mac: Internal functions
Function, association-p: Internal functions
Function, auth-process-p: Exported functions
Function, auth-request-realm: Exported functions
Function, authproc-by-handle: Internal functions
Function, base64-btwoc: Internal functions
Function, btwoc: Internal functions
Function, cancel-response-uri: Exported functions
Function, check-discovery-postcondition: Internal functions
Function, check-realm: Internal functions
Function, check-signature: Internal functions
Function, claimed-id: Exported functions
Function, copy-association: Internal functions
Function, copy-auth-process: Internal functions
Function, copy-message: Exported functions
Function, dh-encrypt/decrypt-key: Internal functions
Function, direct-error-response: Internal functions
Function, direct-request: Internal functions
Function, direct-response: Internal functions
Function, discover: Internal functions
Function, encode-kv: Internal functions
Function, ensure-integer: Internal functions
Function, ensure-trailing-slash: Internal functions
Function, ensure-vector: Internal functions
Function, ensure-vector-length: Internal functions
Function, error-response-message: Internal functions
Function, gc-associations: Internal functions
Function, gc-authprocs: Internal functions
Function, gc-nonces: Internal functions
Function, handle-indirect-response: Exported functions
Function, handle-openid-provider-request: Exported functions
Function, immediate-p: Exported functions
Function, indirect-message-uri: Internal functions
Function, indirect-response: Internal functions
Function, initiate-authentication: Exported functions
Function, make-association: Internal functions
Function, make-auth-process: Internal functions
Function, maybe-uri: Internal functions
Function, message-field: Exported functions
Function, message-field-string: Internal functions
Function, message-v2-p: Exported functions
Function, n-remove-entities: Internal functions
Function, new-association-handle: Internal functions
Function, new-authproc-handle: Internal functions
Function, new-uri: Internal functions
Function, nonce: Internal functions
Function, nonce-universal-time: Internal functions
Function, op-local-id: Exported functions
Function, openid-association-error: Internal functions
Function, openid-discovery-error: Internal functions
Function, parse-kv: Internal functions
Function, perform-html-discovery: Internal functions
Function, perform-xrds-discovery: Internal functions
Function, protocol-version: Exported functions
Function, protocol-version-major: Exported functions
Function, protocol-version-minor: Exported functions
Function, provider-endpoint-uri: Exported functions
Function, remove-dot-segments: Internal functions
Function, request-authentication-uri: Internal functions
Function, return-to: Exported functions
Function, session-digest-type: Internal functions
Function, setup-needed-response: Internal functions
Function, setup-needed-response-message: Internal functions
Function, signal-indirect-error: Internal functions
Function, signature: Internal functions
Function, signed: Internal functions
Function, successful-response-message: Internal functions
Function, successful-response-uri: Exported functions
Function, timestamp: Exported functions
Function, user-setup-url: Internal functions
Function, xrds-location: Exported functions

G
gc-associations: Internal functions
gc-authprocs: Internal functions
gc-nonces: Internal functions
Generic Function, (setf associations): Internal generic functions
Generic Function, (setf associations-lock): Internal generic functions
Generic Function, (setf authproc-timeout): Internal generic functions
Generic Function, (setf authprocs): Internal generic functions
Generic Function, (setf authprocs-lock): Internal generic functions
Generic Function, (setf endpoint-uri): Exported generic functions
Generic Function, (setf nonce-timeout): Internal generic functions
Generic Function, (setf nonces): Internal generic functions
Generic Function, (setf nonces-lock): Internal generic functions
Generic Function, (setf realm): Exported generic functions
Generic Function, (setf root-uri): Exported generic functions
Generic Function, associations: Internal generic functions
Generic Function, associations-lock: Internal generic functions
Generic Function, authproc: Exported generic functions
Generic Function, authproc-timeout: Internal generic functions
Generic Function, authprocs: Internal generic functions
Generic Function, authprocs-lock: Internal generic functions
Generic Function, code: Exported generic functions
Generic Function, endpoint-uri: Exported generic functions
Generic Function, handle-checkid-immediate: Exported generic functions
Generic Function, handle-checkid-setup: Exported generic functions
Generic Function, message: Exported generic functions
Generic Function, nonce-timeout: Internal generic functions
Generic Function, nonces: Internal generic functions
Generic Function, nonces-lock: Internal generic functions
Generic Function, realm: Exported generic functions
Generic Function, reason: Exported generic functions
Generic Function, return-to-uri: Internal generic functions
Generic Function, root-uri: Exported generic functions

H
handle-checkid-immediate: Exported generic functions
handle-checkid-immediate: Exported generic functions
handle-checkid-setup: Exported generic functions
handle-checkid-setup: Exported generic functions
handle-indirect-response: Exported functions
handle-openid-provider-request: Exported functions

I
immediate-p: Exported functions
in-ns: Exported macros
indirect-message-uri: Internal functions
indirect-response: Internal functions
initiate-authentication: Exported functions

M
Macro, define-constant: Internal macros
Macro, in-ns: Exported macros
Macro, string-case: Internal macros
Macro, with-indirect-error-handler: Internal macros
make-association: Internal functions
make-auth-process: Internal functions
maybe-uri: Internal functions
message: Exported generic functions
message: Exported generic functions
message: Exported generic functions
message-field: Exported functions
message-field-string: Internal functions
message-v2-p: Exported functions
Method, (setf associations): Internal generic functions
Method, (setf associations): Internal generic functions
Method, (setf associations-lock): Internal generic functions
Method, (setf associations-lock): Internal generic functions
Method, (setf authproc-timeout): Internal generic functions
Method, (setf authprocs): Internal generic functions
Method, (setf authprocs-lock): Internal generic functions
Method, (setf endpoint-uri): Exported generic functions
Method, (setf nonce-timeout): Internal generic functions
Method, (setf nonces): Internal generic functions
Method, (setf nonces-lock): Internal generic functions
Method, (setf realm): Exported generic functions
Method, (setf root-uri): Exported generic functions
Method, associations: Internal generic functions
Method, associations: Internal generic functions
Method, associations-lock: Internal generic functions
Method, associations-lock: Internal generic functions
Method, authproc: Exported generic functions
Method, authproc-timeout: Internal generic functions
Method, authprocs: Internal generic functions
Method, authprocs-lock: Internal generic functions
Method, code: Exported generic functions
Method, endpoint-uri: Exported generic functions
Method, handle-checkid-immediate: Exported generic functions
Method, handle-checkid-setup: Exported generic functions
Method, message: Exported generic functions
Method, message: Exported generic functions
Method, nonce-timeout: Internal generic functions
Method, nonces: Internal generic functions
Method, nonces-lock: Internal generic functions
Method, realm: Exported generic functions
Method, reason: Exported generic functions
Method, reason: Exported generic functions
Method, reason: Exported generic functions
Method, return-to-uri: Internal generic functions
Method, root-uri: Exported generic functions

N
n-remove-entities: Internal functions
new-association-handle: Internal functions
new-authproc-handle: Internal functions
new-uri: Internal functions
nonce: Internal functions
nonce-timeout: Internal generic functions
nonce-timeout: Internal generic functions
nonce-universal-time: Internal functions
nonces: Internal generic functions
nonces: Internal generic functions
nonces-lock: Internal generic functions
nonces-lock: Internal generic functions

O
op-local-id: Exported functions
openid-association-error: Internal functions
openid-discovery-error: Internal functions

P
parse-kv: Internal functions
perform-html-discovery: Internal functions
perform-xrds-discovery: Internal functions
protocol-version: Exported functions
protocol-version-major: Exported functions
protocol-version-minor: Exported functions
provider-endpoint-uri: Exported functions

R
realm: Exported generic functions
realm: Exported generic functions
reason: Exported generic functions
reason: Exported generic functions
reason: Exported generic functions
reason: Exported generic functions
remove-dot-segments: Internal functions
request-authentication-uri: Internal functions
return-to: Exported functions
return-to-uri: Internal generic functions
return-to-uri: Internal generic functions
root-uri: Exported generic functions
root-uri: Exported generic functions

S
session-digest-type: Internal functions
setup-needed-response: Internal functions
setup-needed-response-message: Internal functions
signal-indirect-error: Internal functions
signature: Internal functions
signed: Internal functions
string-case: Internal macros
successful-response-message: Internal functions
successful-response-uri: Exported functions

T
timestamp: Exported functions

U
user-setup-url: Internal functions

W
with-indirect-error-handler: Internal macros

X
xrds-location: Exported functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   M   N   O   P   R   S   T   U   W   X  

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

A.3 Variables

Jump to:   *   +  
A   C   E   H   I   M   N   O   P   R   S   T   X  
Index Entry  Section

*
*association-handle-counter*: Internal special variables
*auth-handle-counter*: Internal special variables
*default-association-timeout*: Internal special variables
*nonce-counter*: Internal special variables

+
+authproc-handle-parameter+: Exported constants
+cancel-response-message+: Internal constants
+dh-generator+: Internal constants
+dh-prime+: Internal constants
+entities+: Internal constants
+indirect-response-code+: Exported constants
+openid2-namespace+: Internal constants
+openid2-ns-cons+: Internal constants
+protocol-versions+: Internal constants
+setup-needed-response-message+: Internal constants

A
associations: Exported classes
associations: Exported classes
associations-lock: Exported classes
associations-lock: Exported classes
authproc: Exported conditions
authproc-timeout: Exported classes
authprocs: Exported classes
authprocs-lock: Exported classes

C
claimed-id: Exported structures
code: Exported conditions
Constant, +authproc-handle-parameter+: Exported constants
Constant, +cancel-response-message+: Internal constants
Constant, +dh-generator+: Internal constants
Constant, +dh-prime+: Internal constants
Constant, +entities+: Internal constants
Constant, +indirect-response-code+: Exported constants
Constant, +openid2-namespace+: Internal constants
Constant, +openid2-ns-cons+: Internal constants
Constant, +protocol-versions+: Internal constants
Constant, +setup-needed-response-message+: Internal constants

E
endpoint-uri: Exported classes
expires: Internal structures

H
handle: Internal structures
hmac-digest: Internal structures

I
immediate-p: Exported structures

M
mac: Internal structures
message: Exported conditions
message: Internal conditions

N
nonce-timeout: Exported classes
nonces: Exported classes
nonces-lock: Exported classes

O
op-local-id: Exported structures

P
protocol-version-major: Exported structures
protocol-version-minor: Exported structures
provider-endpoint-uri: Exported structures

R
realm: Exported classes
reason: Exported conditions
reason: Internal conditions
reason: Internal conditions
return-to: Exported structures
return-to-uri: Internal conditions
root-uri: Exported classes

S
Slot, associations: Exported classes
Slot, associations: Exported classes
Slot, associations-lock: Exported classes
Slot, associations-lock: Exported classes
Slot, authproc: Exported conditions
Slot, authproc-timeout: Exported classes
Slot, authprocs: Exported classes
Slot, authprocs-lock: Exported classes
Slot, claimed-id: Exported structures
Slot, code: Exported conditions
Slot, endpoint-uri: Exported classes
Slot, expires: Internal structures
Slot, handle: Internal structures
Slot, hmac-digest: Internal structures
Slot, immediate-p: Exported structures
Slot, mac: Internal structures
Slot, message: Exported conditions
Slot, message: Internal conditions
Slot, nonce-timeout: Exported classes
Slot, nonces: Exported classes
Slot, nonces-lock: Exported classes
Slot, op-local-id: Exported structures
Slot, protocol-version-major: Exported structures
Slot, protocol-version-minor: Exported structures
Slot, provider-endpoint-uri: Exported structures
Slot, realm: Exported classes
Slot, reason: Exported conditions
Slot, reason: Internal conditions
Slot, reason: Internal conditions
Slot, return-to: Exported structures
Slot, return-to-uri: Internal conditions
Slot, root-uri: Exported classes
Slot, timestamp: Exported structures
Slot, xrds-location: Exported structures
Special Variable, *association-handle-counter*: Internal special variables
Special Variable, *auth-handle-counter*: Internal special variables
Special Variable, *default-association-timeout*: Internal special variables
Special Variable, *nonce-counter*: Internal special variables

T
timestamp: Exported structures

X
xrds-location: Exported structures

Jump to:   *   +  
A   C   E   H   I   M   N   O   P   R   S   T   X  

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

A.4 Data types

Jump to:   A   C   I   O   P   R   S  
Index Entry  Section

A
association: Internal structures
auth-process: Exported structures

C
cl-openid: The cl-openid system
cl-openid: The cl-openid package
cl-openid.system: The cl-openid<dot>system package
Class, openid-provider: Exported classes
Class, relying-party: Exported classes
Condition, indirect-error: Internal conditions
Condition, openid-assertion-error: Exported conditions
Condition, openid-association-error: Internal conditions
Condition, openid-discovery-error: Internal conditions
Condition, openid-request-error: Internal conditions

I
indirect-error: Internal conditions

O
openid-assertion-error: Exported conditions
openid-association-error: Internal conditions
openid-discovery-error: Internal conditions
openid-provider: Exported classes
openid-request-error: Internal conditions

P
Package, cl-openid: The cl-openid package
Package, cl-openid.system: The cl-openid<dot>system package

R
relying-party: Exported classes

S
Structure, association: Internal structures
Structure, auth-process: Exported structures
System, cl-openid: The cl-openid system

Jump to:   A   C   I   O   P   R   S