The cl-oauth Reference Manual

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-oauth Reference Manual [Contents][Index]

3 Modules

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

cl-oauth/src
cl-oauth/src/util
cl-oauth/src/core

Next: cl-oauth/src/util, Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-oauth/src`

Source

Parent Component

cl-oauth (system).

Child Components

package.lisp (file).
util (module).
core (module).

Next: cl-oauth/src/core, Previous: cl-oauth/src, Up: Modules [Contents][Index]

3.2 `cl-oauth/src/util`

Dependency

package.lisp (file).

Source

Parent Component

src (module).

Child Components

misc.lisp (file).
query-string.lisp (file).
uri.lisp (file).

Previous: cl-oauth/src/util, Up: Modules [Contents][Index]

3.3 `cl-oauth/src/core`

Dependencies

package.lisp (file).
util (module).

Source

Parent Component

src (module).

Child Components

crypto.lisp (file).
request-adapter.lisp (file).
error-handling.lisp (file).
parameters.lisp (file).
signature.lisp (file).
tokens.lisp (file).
consumer.lisp (file).
service-provider.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-oauth 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]

4.1 Lisp

cl-oauth/cl-oauth.asd
cl-oauth/src/package.lisp
cl-oauth/src/util/misc.lisp
cl-oauth/src/util/query-string.lisp
cl-oauth/src/util/uri.lisp
cl-oauth/src/core/crypto.lisp
cl-oauth/src/core/request-adapter.lisp
cl-oauth/src/core/error-handling.lisp
cl-oauth/src/core/parameters.lisp
cl-oauth/src/core/signature.lisp
cl-oauth/src/core/tokens.lisp
cl-oauth/src/core/consumer.lisp
cl-oauth/src/core/service-provider.lisp

Next: cl-oauth/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-oauth/cl-oauth.asd`

Source: cl-oauth.asd.
Parent Component: cl-oauth (system).
ASDF Systems: cl-oauth.
Packages: cl-oauth-asd.

Next: cl-oauth/src/util/misc.lisp, Previous: cl-oauth/cl-oauth.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-oauth/src/package.lisp`

Source: cl-oauth.asd.
Parent Component: src (module).
Packages: cl-oauth.

Next: cl-oauth/src/util/query-string.lisp, Previous: cl-oauth/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-oauth/src/util/misc.lisp`

Source

Parent Component

util (module).

Internals

+unix-to-universal-time+ (constant).
alist->plist (function).
between (function).
get-unix-time (function).
splice-alist (function).

Next: cl-oauth/src/util/uri.lisp, Previous: cl-oauth/src/util/misc.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-oauth/src/util/query-string.lisp`

Dependency

misc.lisp (file).

Source

Parent Component

util (module).

Internals

alist->query-string (function).
query-string->alist (function).

Next: cl-oauth/src/core/crypto.lisp, Previous: cl-oauth/src/util/query-string.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-oauth/src/util/uri.lisp`

Dependency

query-string.lisp (file).

Source

Parent Component

util (module).

Public Interface

url-encode (function).

Internals

+utf-8+ (special variable).
normalize-uri (method).
normalize-uri (method).
upgrade-vector (macro).
url-decode (function).

Next: cl-oauth/src/core/request-adapter.lisp, Previous: cl-oauth/src/util/uri.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-oauth/src/core/crypto.lisp`

Source: cl-oauth.asd.
Parent Component: core (module).
Public Interface: hmac-sha1 (function).
Internals: string-or-octets->octets (function).

Next: cl-oauth/src/core/error-handling.lisp, Previous: cl-oauth/src/core/crypto.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-oauth/src/core/request-adapter.lisp`

Source

Parent Component

core (module).

Public Interface

*request* (special variable).
*request-adapter* (special variable).
abort-request (function).
auth-parameters (function).
get-parameters (function).
init-default-request-adapter (function).
make-hunchentoot-request-adapter (function).
make-request-adapter (function).
post-parameters (function).
request (function).
request-adapter (structure).
request-method (function).
request-uri (function).

Internals

copy-request-adapter (function).
request-adapter-abort-request-fn (reader).
(setf request-adapter-abort-request-fn) (writer).
request-adapter-auth-parameters-fn (reader).
(setf request-adapter-auth-parameters-fn) (writer).
request-adapter-get-parameters-fn (reader).
(setf request-adapter-get-parameters-fn) (writer).
request-adapter-p (function).
request-adapter-post-parameters-fn (reader).
(setf request-adapter-post-parameters-fn) (writer).
request-adapter-request-method-fn (reader).
(setf request-adapter-request-method-fn) (writer).
request-adapter-request-object-fn (reader).
(setf request-adapter-request-object-fn) (writer).
request-adapter-request-uri-fn (reader).
(setf request-adapter-request-uri-fn) (writer).

Next: cl-oauth/src/core/parameters.lisp, Previous: cl-oauth/src/core/request-adapter.lisp, Up: Lisp [Contents][Index]

4.1.8 `cl-oauth/src/core/error-handling.lisp`

Dependency

request-adapter.lisp (file).

Source

Parent Component

core (module).

Public Interface

bad-request (condition).
default-error-handler (function).
http-error (condition).
protocol-assert (macro).
raise-error (function).
unauthorized (condition).

Internals

http-error-reason-phrase (reader method).
http-error-status-code (reader method).

Next: cl-oauth/src/core/signature.lisp, Previous: cl-oauth/src/core/error-handling.lisp, Up: Lisp [Contents][Index]

4.1.9 `cl-oauth/src/core/parameters.lisp`

Dependency

request-adapter.lisp (file).

Source

Parent Component

core (module).

Public Interface

normalized-parameters (function).
parameter (function).
sort-parameters (function).

Internals

*parameters-cache* (special variable).
*signature-cache* (special variable).
oauth-parameter-p (function).
remove-oauth-parameters (function).

Next: cl-oauth/src/core/tokens.lisp, Previous: cl-oauth/src/core/parameters.lisp, Up: Lisp [Contents][Index]

4.1.10 `cl-oauth/src/core/signature.lisp`

Source

Parent Component

core (module).

Public Interface

encode-signature (function).
hmac-key (function).
signature-base-string (function).

Next: cl-oauth/src/core/consumer.lisp, Previous: cl-oauth/src/core/signature.lisp, Up: Lisp [Contents][Index]

4.1.11 `cl-oauth/src/core/tokens.lisp`

Dependency

signature.lisp (file).

Source

Parent Component

core (module).

Public Interface

access-token (class).
access-token-authorization-expires (reader method).
access-token-expired-p (function).
access-token-expires (reader method).
access-token-session-handle (reader method).
consumer-token (class).
make-access-token (function).
make-consumer-token (function).
make-request-token (function).
print-object (method).
request-token (class).
request-token-authorized-p (reader method).
(setf request-token-authorized-p) (writer method).
request-token-callback-uri (reader method).
request-token-verification-code (reader method).
(setf request-token-verification-code) (writer method).
token (class).
token-consumer (reader method).
(setf token-consumer) (writer method).
token-key (reader method).
token-secret (reader method).
token-user-data (reader method).
(setf token-user-data) (writer method).

Internals

access-token-origin-uri (reader method).
consumer-ref-mixin (class).
consumer-token-last-timestamp (reader method).
(setf consumer-token-last-timestamp) (writer method).
random-key (function).
random-secret (function).
random-verification-code (function).

Next: cl-oauth/src/core/service-provider.lisp, Previous: cl-oauth/src/core/tokens.lisp, Up: Lisp [Contents][Index]

4.1.12 `cl-oauth/src/core/consumer.lisp`

Dependencies

tokens.lisp (file).
parameters.lisp (file).
error-handling.lisp (file).

Source

Parent Component

core (module).

Public Interface

access-protected-resource (function).
authorize-request-token (function).
authorize-request-token-from-request (function).
make-authorization-uri (function).
obtain-access-token (function).
obtain-request-token (function).

Internals

build-auth-string (function).
generate-auth-parameters (function).
generate-nonce (function).
get-problem-report (function).
get-problem-report-from-headers (function).
http-request (function).
maybe-refresh-access-token (function).
refresh-access-token (function).
uri-with-additional-query-part (function).

Previous: cl-oauth/src/core/consumer.lisp, Up: Lisp [Contents][Index]

4.1.13 `cl-oauth/src/core/service-provider.lisp`

Dependencies

tokens.lisp (file).
parameters.lisp (file).
error-handling.lisp (file).

Source

Parent Component

core (module).

Public Interface

*protocol-version* (special variable).
check-nonce-and-timestamp (function).
check-signature (function).
check-verification-code (function).
check-version (function).
finalize-callback-uri (function).
get-supplied-request-token (function).
make-response (function).
register-token (method).
register-token (method).
register-token (method).
request-token-response (function).
unregister-token (method).
unregister-token (method).
unregister-token (method).
validate-access-token (function).
validate-access-token-request (function).
validate-request-token-request (function).

Internals

*issued-access-tokens* (special variable).
*issued-request-tokens* (special variable).
*registered-consumers* (special variable).
access-token-response (function).
get-consumer-token (function).
get-supplied-access-token (function).
get-supplied-callback-uri (function).
get-supplied-consumer-token (function).
ignore-oauth-errors (macro).
invalidate-request-token (function).

Next: Definitions, Previous: Files, Up: The cl-oauth Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-oauth
cl-oauth-asd

Next: cl-oauth-asd, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-oauth`

Source

package.lisp.

Nickname

oauth

Use List

anaphora.
common-lisp.
f-underscore.

Public Interface

*protocol-version* (special variable).
*request* (special variable).
*request-adapter* (special variable).
abort-request (function).
access-protected-resource (function).
access-token (class).
access-token-authorization-expires (generic reader).
access-token-expired-p (function).
access-token-expires (generic reader).
access-token-session-handle (generic reader).
auth-parameters (function).
authorize-request-token (function).
authorize-request-token-from-request (function).
bad-request (condition).
check-nonce-and-timestamp (function).
check-signature (function).
check-verification-code (function).
check-version (function).
consumer-token (class).
default-error-handler (function).
encode-signature (function).
finalize-callback-uri (function).
get-parameters (function).
get-supplied-request-token (function).
hmac-key (function).
hmac-sha1 (function).
http-error (condition).
init-default-request-adapter (function).
make-access-token (function).
make-authorization-uri (function).
make-consumer-token (function).
make-hunchentoot-request-adapter (function).
make-request-adapter (function).
make-request-token (function).
make-response (function).
normalized-parameters (function).
obtain-access-token (function).
obtain-request-token (function).
parameter (function).
post-parameters (function).
protocol-assert (macro).
raise-error (function).
register-token (generic function).
request (function).
request-adapter (structure).
request-method (function).
request-token (class).
request-token-authorized-p (generic reader).
(setf request-token-authorized-p) (generic writer).
request-token-callback-uri (generic reader).
request-token-response (function).
request-token-verification-code (generic reader).
(setf request-token-verification-code) (generic writer).
request-uri (function).
signature-base-string (function).
sort-parameters (function).
token (class).
token-consumer (generic reader).
(setf token-consumer) (generic writer).
token-key (generic reader).
token-secret (generic reader).
token-user-data (generic reader).
(setf token-user-data) (generic writer).
unauthorized (condition).
unregister-token (generic function).
url-encode (function).
validate-access-token (function).
validate-access-token-request (function).
validate-request-token-request (function).

Internals

*issued-access-tokens* (special variable).
*issued-request-tokens* (special variable).
*parameters-cache* (special variable).
*registered-consumers* (special variable).
*signature-cache* (special variable).
+unix-to-universal-time+ (constant).
+utf-8+ (special variable).
access-token-origin-uri (generic reader).
access-token-response (function).
alist->plist (function).
alist->query-string (function).
between (function).
build-auth-string (function).
consumer-ref-mixin (class).
consumer-token-last-timestamp (generic reader).
(setf consumer-token-last-timestamp) (generic writer).
copy-request-adapter (function).
generate-auth-parameters (function).
generate-nonce (function).
get-consumer-token (function).
get-problem-report (function).
get-problem-report-from-headers (function).
get-supplied-access-token (function).
get-supplied-callback-uri (function).
get-supplied-consumer-token (function).
get-unix-time (function).
http-error-reason-phrase (generic reader).
http-error-status-code (generic reader).
http-request (function).
ignore-oauth-errors (macro).
invalidate-request-token (function).
maybe-refresh-access-token (function).
normalize-uri (generic function).
oauth-parameter-p (function).
query-string->alist (function).
random-key (function).
random-secret (function).
random-verification-code (function).
refresh-access-token (function).
remove-oauth-parameters (function).
request-adapter-abort-request-fn (reader).
(setf request-adapter-abort-request-fn) (writer).
request-adapter-auth-parameters-fn (reader).
(setf request-adapter-auth-parameters-fn) (writer).
request-adapter-get-parameters-fn (reader).
(setf request-adapter-get-parameters-fn) (writer).
request-adapter-p (function).
request-adapter-post-parameters-fn (reader).
(setf request-adapter-post-parameters-fn) (writer).
request-adapter-request-method-fn (reader).
(setf request-adapter-request-method-fn) (writer).
request-adapter-request-object-fn (reader).
(setf request-adapter-request-object-fn) (writer).
request-adapter-request-uri-fn (reader).
(setf request-adapter-request-uri-fn) (writer).
splice-alist (function).
string-or-octets->octets (function).
upgrade-vector (macro).
uri-with-additional-query-part (function).
url-decode (function).

Previous: cl-oauth, Up: Packages [Contents][Index]

5.2 `cl-oauth-asd`

Source

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-oauth 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]

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

6.1.1 Special variables

Special Variable: *protocol-version* ¶

Package: cl-oauth.
Source: service-provider.lisp.

Special Variable: *request* ¶

User-supplied request override. Only if you know what you’re doing.

Package: cl-oauth.
Source: request-adapter.lisp.

Special Variable: *request-adapter* ¶

Set this variable to an instance of REQUEST-ADAPTER tailored to your web server.

Package: cl-oauth.
Source: request-adapter.lisp.

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

6.1.2 Macros

Macro: protocol-assert (&body body) ¶

Package: cl-oauth.
Source: error-handling.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.3 Ordinary functions

Function: abort-request (result) ¶

Return the string RESULT immediately from the request handler.

Package: cl-oauth.
Source: request-adapter.lisp.

Function: access-protected-resource (uri access-token &rest kwargs &key consumer-token on-refresh timestamp user-parameters additional-headers version drakma-args auth-location request-method signature-method include-user-parameters-in-signature-p) ¶

Access the protected resource at URI using ACCESS-TOKEN.

If the token contains OAuth Session information it will be checked for validity before the request is made. Should the server notify us that it has prematurely expired the token will be refresh as well and the request sent again using the new token. ON-REFRESH will be called whenever the access token is renewed.

Package: cl-oauth.
Source: consumer.lisp.

Function: access-token-expired-p (access-token) ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: auth-parameters (&optional request) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: authorize-request-token (request-token) ¶

Authorize a request token explicitly. Returns the authorized token.

Package: cl-oauth.
Source: consumer.lisp.

Function: authorize-request-token-from-request (request-token-lookup-fn) ¶

Authorize a request token. Must be running in request context.

REQUEST-TOKEN-LOOKUP-FN will be called with the request token key and must return a valid unauthorized request token or NIL.

Returns the authorized token or NIL if the token couldn’t be found.

Package: cl-oauth.
Source: consumer.lisp.

Function: check-nonce-and-timestamp (consumer-token) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: check-signature () ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: check-verification-code () ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: check-version () ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: default-error-handler (condition) ¶

Default error handler for conditions of type HTTP-ERROR.

Package: cl-oauth.
Source: error-handling.lisp.

Function: encode-signature (octets url-encode-p) ¶

9.2.1

Package: cl-oauth.
Source: signature.lisp.

Function: finalize-callback-uri (request-token) ¶

Prepares the callback URI of REQUEST-TOKEN for redirection.

Package: cl-oauth.
Source: service-provider.lisp.

Function: get-parameters (&optional request) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: get-supplied-request-token (&key check-verification-code-p) ¶

Utility function that extracts the Consumer-supplied request token from a list of normalized parameters. Guards against non-existing and unknown tokens. Returns the request token on success.

Package: cl-oauth.
Source: service-provider.lisp.

Function: hmac-key (consumer-secret &optional token-secret) ¶

9.2

Package: cl-oauth.
Source: signature.lisp.

Function: hmac-sha1 (s key) ¶

Package: cl-oauth.
Source: crypto.lisp.

Function: init-default-request-adapter () ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: make-access-token (&rest args) ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: make-authorization-uri (uri request-token &key callback-uri user-parameters) ¶

Return the service provider’s authorization URI. Use the resulting PURI for a redirect. [6.2.1] in 1.0.

Package: cl-oauth.
Source: consumer.lisp.

Function: make-consumer-token (&rest args) ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: make-hunchentoot-request-adapter () ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: make-request-adapter (&key request-object-fn request-method-fn request-uri-fn abort-request-fn auth-parameters-fn post-parameters-fn get-parameters-fn) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: make-request-token (&rest args) ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: make-response (alist) ¶

[5.3]

Package: cl-oauth.
Source: service-provider.lisp.

Function: normalized-parameters (&key remove-duplicates-p) ¶

Collect request parameters and remove those excluded by the standard. See 9.1.1. Note: REMOVE-DUPLICATES-P has no effect right now.

Package: cl-oauth.
Source: parameters.lisp.

Function: obtain-access-token (uri request-or-access-token &key consumer-token request-method auth-location version timestamp xauth-username xauth-password drakma-args signature-method) ¶

Additional parameters will be stored in the USER-DATA slot of the token. POST is recommended as request method. [6.3.1]

Package: cl-oauth.
Source: consumer.lisp.

Function: obtain-request-token (uri consumer-token &key version user-parameters drakma-args timestamp auth-location request-method callback-uri additional-headers signature-method include-user-parameters-in-signature-p) ¶

Additional parameters will be stored in the USER-DATA slot of the token.

Package: cl-oauth.
Source: consumer.lisp.

Function: parameter (name &key test) ¶

Note: OAuth parameters are case-sensitive per section 5. The case of user-supplied parameters is not restricted.

Package: cl-oauth.
Source: parameters.lisp.

Function: post-parameters (&optional request) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: raise-error (type &optional reason-phrase-fmt &rest reason-phrase-args) ¶

Package: cl-oauth.
Source: error-handling.lisp.

Function: request () ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: request-method (&optional request) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: request-token-response (request-token &rest additional-parameters) ¶

Respond to a valid request token request. [6.1.2]

Package: cl-oauth.
Source: service-provider.lisp.

Function: request-uri (&optional request) ¶

Return the request uri including protocol, host, port and path. Other parts like the query string are optional and will be ignored. The result type is (or string puri:uri).

Package: cl-oauth.
Source: request-adapter.lisp.

Function: signature-base-string (&key uri request-method parameters) ¶

Package: cl-oauth.
Source: signature.lisp.

Function: sort-parameters (parameters) ¶

Sort PARAMETERS according to the OAuth spec. This is a destructive operation.

Package: cl-oauth.
Source: parameters.lisp.

Function: url-encode (input &optional external-format) ¶

URL-encodes INPUT according to the percent encoding rules of RFC5849 (section 3.6). If a string is passed as INPUT, it is encoded using the external format EXTERNAL-FORMAT. If a vector of bytes is passed, the values are used verbatim.

Package: cl-oauth.
Source: uri.lisp.

Function: validate-access-token () ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: validate-access-token-request (&key access-token-ctor) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: validate-request-token-request (&key request-token-ctor allow-oob-callback-p) ¶

Check whether REQUEST is a valid request token request.

Returns the supplied Consumer callback (a PURI:URI) or NIL if the callback is supposed to be transferred oob. [6.1.1]

Package: cl-oauth.
Source: service-provider.lisp.

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

6.1.4 Generic functions

Generic Reader: access-token-authorization-expires (object) ¶

Package

Methods

Reader Method: access-token-authorization-expires ((access-token access-token)) ¶

Universal time when this token’s session expires.

Source: tokens.lisp.
Target Slot: authorization-expires.

Generic Reader: access-token-expires (object) ¶

Package

Methods

Reader Method: access-token-expires ((access-token access-token)) ¶

Universal time when this token expires.

Source: tokens.lisp.
Target Slot: expires.

Generic Reader: access-token-session-handle (object) ¶

Package

Methods

Reader Method: access-token-session-handle ((access-token access-token)) ¶

automatically generated reader method

Source: tokens.lisp.
Target Slot: session-handle.

Generic Function: register-token (token) ¶

Package

Methods

Method: register-token ((token access-token)) ¶

Source: service-provider.lisp.

Method: register-token ((token request-token)) ¶

Source: service-provider.lisp.

Method: register-token ((token consumer-token)) ¶

Source: service-provider.lisp.

Generic Reader: request-token-authorized-p (object) ¶

Package

Methods

Reader Method: request-token-authorized-p ((request-token request-token)) ¶

automatically generated reader method

Source: tokens.lisp.
Target Slot: authorized-p.

Generic Writer: (setf request-token-authorized-p) (object) ¶

Package

Methods

Writer Method: (setf request-token-authorized-p) ((request-token request-token)) ¶

automatically generated writer method

Source: tokens.lisp.
Target Slot: authorized-p.

Generic Reader: request-token-callback-uri (object) ¶

Package

Methods

Reader Method: request-token-callback-uri ((request-token request-token)) ¶

Callback URI for this request token. NIL means oob.

Source: tokens.lisp.
Target Slot: callback-uri.

Generic Reader: request-token-verification-code (object) ¶

Generic Writer: (setf request-token-verification-code) (object) ¶

Package

Methods

Reader Method: request-token-verification-code ((request-token request-token)) ¶

Writer Method: (setf request-token-verification-code) ((request-token request-token)) ¶

Might be NIL for OAuth 1.0

Source: tokens.lisp.
Target Slot: verification-code.

Generic Reader: token-consumer (object) ¶

Generic Writer: (setf token-consumer) (object) ¶

Package

Methods

Reader Method: token-consumer ((consumer-ref-mixin consumer-ref-mixin)) ¶

Writer Method: (setf token-consumer) ((consumer-ref-mixin consumer-ref-mixin)) ¶

The Consumer that originally requested this token.

Source: tokens.lisp.
Target Slot: consumer.

Generic Reader: token-key (object) ¶

Package

Methods

Reader Method: token-key ((token token)) ¶

automatically generated reader method

Source: tokens.lisp.
Target Slot: key.

Generic Reader: token-secret (object) ¶

Package

Methods

Reader Method: token-secret ((token token)) ¶

automatically generated reader method

Source: tokens.lisp.
Target Slot: secret.

Generic Reader: token-user-data (object) ¶

Generic Writer: (setf token-user-data) (object) ¶

Package

Methods

Reader Method: token-user-data ((token token)) ¶

Writer Method: (setf token-user-data) ((token token)) ¶

Application-specific data associated with this token; an alist.

Source: tokens.lisp.
Target Slot: user-data.

Generic Function: unregister-token (token) ¶

Package

Methods

Method: unregister-token ((token access-token)) ¶

Source: service-provider.lisp.

Method: unregister-token ((token request-token)) ¶

Source: service-provider.lisp.

Method: unregister-token ((token consumer-token)) ¶

Source: service-provider.lisp.

Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]

6.1.5 Standalone methods

Method: print-object ((obj token) stream) ¶

Faking STRUCT-like output. It would probably be better to use
the pretty printer; the code for sb-kernel::%default-structure-pretty-print will be a useful template.

Source: tokens.lisp.

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

6.1.6 Conditions

Condition: bad-request ¶

Package

Source

error-handling.lisp.

Direct superclasses

http-error.

Direct Default Initargs

Initarg	Value
`:reason-phrase`	`bad request`
`:status-code`	`400`

Condition: http-error ¶

Package

Source

error-handling.lisp.

Direct superclasses

error.

Direct subclasses

bad-request.
unauthorized.

Direct methods

http-error-reason-phrase.
http-error-status-code.

Direct slots

Slot: status-code ¶

Initargs: :status-code
Readers: http-error-status-code.
Writers: This slot is read-only.

Slot: reason-phrase ¶

Initargs: :reason-phrase
Readers: http-error-reason-phrase.
Writers: This slot is read-only.

Condition: unauthorized ¶

Package

Source

error-handling.lisp.

Direct superclasses

http-error.

Direct Default Initargs

Initarg	Value
`:reason-phrase`	`unauthorized`
`:status-code`	`401`

Next: Classes, Previous: Conditions, Up: Public Interface [Contents][Index]

6.1.7 Structures

Structure: request-adapter ¶

An adapter for server-specific parts of OAuth.
The return value of REQUEST-OBJECT-FN must be comparable with EQ.

Package

Source

request-adapter.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: request-object-fn ¶

Type: (or function symbol null)
Readers: request-adapter-request-object-fn.
Writers: (setf request-adapter-request-object-fn).

Slot: request-method-fn ¶

Type: (or function symbol null)
Readers: request-adapter-request-method-fn.
Writers: (setf request-adapter-request-method-fn).

Slot: request-uri-fn ¶

Type: (or function symbol null)
Readers: request-adapter-request-uri-fn.
Writers: (setf request-adapter-request-uri-fn).

Slot: abort-request-fn ¶

Type: (or function symbol null)
Readers: request-adapter-abort-request-fn.
Writers: (setf request-adapter-abort-request-fn).

Slot: auth-parameters-fn ¶

Type: (or function symbol null)
Readers: request-adapter-auth-parameters-fn.
Writers: (setf request-adapter-auth-parameters-fn).

Slot: post-parameters-fn ¶

Type: (or function symbol null)
Readers: request-adapter-post-parameters-fn.
Writers: (setf request-adapter-post-parameters-fn).

Slot: get-parameters-fn ¶

Type: (or function symbol null)
Readers: request-adapter-get-parameters-fn.
Writers: (setf request-adapter-get-parameters-fn).

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

6.1.8 Classes

Class: access-token ¶

Package

Source

Direct superclasses

consumer-ref-mixin.
token.

Direct methods

access-token-authorization-expires.
access-token-expires.
access-token-origin-uri.
access-token-session-handle.
register-token.
unregister-token.

Direct slots

Slot: session-handle ¶

Type: (or string null)
Initargs: :session-handle
Readers: access-token-session-handle.
Writers: This slot is read-only.

Slot: expires ¶

Universal time when this token expires.

Type: (or integer null)
Initargs: :expires
Readers: access-token-expires.
Writers: This slot is read-only.

Slot: authorization-expires ¶

Universal time when this token’s session expires.

Type: (or integer null)
Initargs: :authorization-expires
Readers: access-token-authorization-expires.
Writers: This slot is read-only.

Slot: origin-uri ¶

URI this access token has been obtained from. Needed for refresh.

Type: (or puri:uri string null)
Initargs: :origin-uri
Readers: access-token-origin-uri.
Writers: This slot is read-only.

Class: consumer-token ¶

Package

Source

Direct superclasses

token.

Direct methods

(setf consumer-token-last-timestamp).
consumer-token-last-timestamp.
register-token.
unregister-token.

Direct slots

Slot: last-timestamp ¶

Type: integer
Initform: 0
Readers: consumer-token-last-timestamp.
Writers: (setf consumer-token-last-timestamp).

Class: request-token ¶

Package

Source

Direct superclasses

consumer-ref-mixin.
token.

Direct methods

register-token.
(setf request-token-authorized-p).
request-token-authorized-p.
request-token-callback-uri.
(setf request-token-verification-code).
request-token-verification-code.
unregister-token.

Direct slots

Slot: callback-uri ¶

Callback URI for this request token. NIL means oob.

Type: (or puri:uri null)
Initargs: :callback-uri
Readers: request-token-callback-uri.
Writers: This slot is read-only.

Slot: verification-code ¶

Might be NIL for OAuth 1.0

Type: (or string null)
Initform: (cl-oauth::random-verification-code)
Initargs: :verification-code
Readers: request-token-verification-code.
Writers: (setf request-token-verification-code).

Slot: authorized-p ¶

Type: boolean
Readers: request-token-authorized-p.
Writers: (setf request-token-authorized-p).

Class: token ¶

Package

Source

Direct subclasses

access-token.
consumer-token.
request-token.

Direct methods

print-object.
token-key.
token-secret.
(setf token-user-data).
token-user-data.

Direct slots

Slot: key ¶

Type: string
Initform: (cl-oauth::random-key)
Initargs: :key
Readers: token-key.
Writers: This slot is read-only.

Slot: secret ¶

Type: string
Initform: (cl-oauth::random-secret)
Initargs: :secret
Readers: token-secret.
Writers: This slot is read-only.

Slot: user-data ¶

Application-specific data associated with this token; an alist.

Type: list
Initargs: :user-data
Readers: token-user-data.
Writers: (setf token-user-data).

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

6.2 Internals

Constants
Special variables
Macros
Ordinary functions
Generic functions
Classes

Next: Special variables, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Constants

Constant: +unix-to-universal-time+ ¶

Package: cl-oauth.
Source: misc.lisp.

Next: Macros, Previous: Constants, Up: Internals [Contents][Index]

6.2.2 Special variables

Special Variable: *issued-access-tokens* ¶

Package: cl-oauth.
Source: service-provider.lisp.

Special Variable: *issued-request-tokens* ¶

Package: cl-oauth.
Source: service-provider.lisp.

Special Variable: *parameters-cache* ¶

Per-request cache for parameters in OAuth requests.

Package: cl-oauth.
Source: parameters.lisp.

Special Variable: *registered-consumers* ¶

Package: cl-oauth.
Source: service-provider.lisp.

Special Variable: *signature-cache* ¶

Per-request cache for signatures in OAuth requests.

Package: cl-oauth.
Source: parameters.lisp.

Special Variable: +utf-8+ ¶

Package: cl-oauth.
Source: uri.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

6.2.3 Macros

Macro: ignore-oauth-errors (&body body) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Macro: upgrade-vector (vector new-type &key converter) ¶

Returns a vector with the same length and the same elements as VECTOR (a variable holding a vector) but having element type NEW-TYPE. If CONVERTER is not NIL, it should designate a function which will be applied to each element of VECTOR before the result is stored in the new vector. The resulting vector will have a fill pointer set to its end.

The macro also uses SETQ to store the new vector in VECTOR.

Package: cl-oauth.
Source: uri.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

6.2.4 Ordinary functions

Function: access-token-response (access-token &rest additional-parameters) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: alist->plist (alist) ¶

Converts an alist to plist.

Package: cl-oauth.
Source: misc.lisp.

Function: alist->query-string (alist &key include-leading-ampersand url-encode) ¶

Package: cl-oauth.
Source: query-string.lisp.

Function: between (what lower upper) ¶

Package: cl-oauth.
Source: misc.lisp.

Function: build-auth-string (parameters) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: copy-request-adapter (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Function: generate-auth-parameters (consumer signature-method timestamp version &optional token) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: generate-nonce (&optional size) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: get-consumer-token (key) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: get-problem-report (headers body) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: get-problem-report-from-headers (headers) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: get-supplied-access-token () ¶

Utility function that extracts the Consumer-supplied request token from a list of normalized parameters. Guards against non-existing and unknown tokens. Returns the request token on success.

Package: cl-oauth.
Source: service-provider.lisp.

Function: get-supplied-callback-uri (&key allow-oob-callback-p allow-none) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: get-supplied-consumer-token () ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: get-unix-time (&optional ut) ¶

Package: cl-oauth.
Source: misc.lisp.

Function: http-request (uri &key auth-location method auth-parameters parameters additional-headers drakma-args) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: invalidate-request-token (request-token) ¶

Package: cl-oauth.
Source: service-provider.lisp.

Function: maybe-refresh-access-token (access-token &optional on-refresh) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: oauth-parameter-p (parameter) ¶

Return T if PARAMETER starts with "oauth_". PARAMETER is a string denoting the parameter name.

Package: cl-oauth.
Source: parameters.lisp.

Function: query-string->alist (query-string) ¶

Package: cl-oauth.
Source: query-string.lisp.

Function: random-key () ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: random-secret () ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: random-verification-code () ¶

Package: cl-oauth.
Source: tokens.lisp.

Function: refresh-access-token (access-token) ¶

Package: cl-oauth.
Source: consumer.lisp.

Function: remove-oauth-parameters (parameters) ¶

Package: cl-oauth.
Source: parameters.lisp.

Reader: request-adapter-abort-request-fn (instance) ¶

Writer: (setf request-adapter-abort-request-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: abort-request-fn.

Reader: request-adapter-auth-parameters-fn (instance) ¶

Writer: (setf request-adapter-auth-parameters-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: auth-parameters-fn.

Reader: request-adapter-get-parameters-fn (instance) ¶

Writer: (setf request-adapter-get-parameters-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: get-parameters-fn.

Function: request-adapter-p (object) ¶

Package: cl-oauth.
Source: request-adapter.lisp.

Reader: request-adapter-post-parameters-fn (instance) ¶

Writer: (setf request-adapter-post-parameters-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: post-parameters-fn.

Reader: request-adapter-request-method-fn (instance) ¶

Writer: (setf request-adapter-request-method-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: request-method-fn.

Reader: request-adapter-request-object-fn (instance) ¶

Writer: (setf request-adapter-request-object-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: request-object-fn.

Reader: request-adapter-request-uri-fn (instance) ¶

Writer: (setf request-adapter-request-uri-fn) (instance) ¶

Package: cl-oauth.
Source: request-adapter.lisp.
Target Slot: request-uri-fn.

Function: splice-alist (alist) ¶

Package: cl-oauth.
Source: misc.lisp.

Function: string-or-octets->octets (x) ¶

Package: cl-oauth.
Source: crypto.lisp.

Function: uri-with-additional-query-part (uri query-part) ¶

Given a URI string or PURI uri, adds the string QUERY-PART to the end of the URI. If it has query params already they are added onto it.

Package: cl-oauth.
Source: consumer.lisp.

Function: url-decode (string &optional external-format) ¶

Decodes a URL-encoded STRING which is assumed to be encoded using the external format EXTERNAL-FORMAT.

Package: cl-oauth.
Source: uri.lisp.

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

6.2.5 Generic functions

Generic Reader: access-token-origin-uri (object) ¶

Package

Methods

Reader Method: access-token-origin-uri ((access-token access-token)) ¶

URI this access token has been obtained from. Needed for refresh.

Source: tokens.lisp.
Target Slot: origin-uri.

Generic Reader: consumer-token-last-timestamp (object) ¶

Package

Methods

Reader Method: consumer-token-last-timestamp ((consumer-token consumer-token)) ¶

automatically generated reader method

Source: tokens.lisp.
Target Slot: last-timestamp.

Generic Writer: (setf consumer-token-last-timestamp) (object) ¶

Package

Methods

Writer Method: (setf consumer-token-last-timestamp) ((consumer-token consumer-token)) ¶

automatically generated writer method

Source: tokens.lisp.
Target Slot: last-timestamp.

Generic Reader: http-error-reason-phrase (condition) ¶

Package

Methods

Reader Method: http-error-reason-phrase ((condition http-error)) ¶

Source: error-handling.lisp.
Target Slot: reason-phrase.

Generic Reader: http-error-status-code (condition) ¶

Package

Methods

Reader Method: http-error-status-code ((condition http-error)) ¶

Source: error-handling.lisp.
Target Slot: status-code.

Generic Function: normalize-uri (uri) ¶

Package

Methods

Method: normalize-uri ((uri uri)) ¶

9.1.2

Source: uri.lisp.

Method: normalize-uri ((uri string)) ¶

Source: uri.lisp.

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

6.2.6 Classes

Class: consumer-ref-mixin ¶

Mixin for classes that refer to a consumer.

Package

Source