The cl-oauth Reference Manual

Table of Contents

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

The cl-oauth Reference Manual

This is the cl-oauth Reference Manual, version 3, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:12:11 2018 GMT+0.


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

1 Introduction

This is cl-oauth, an implementation of the OAuth 1.0a standard
in Common Lisp.

Spec URI: http://oauth.net/core/1.0a

Section numbers mentioned in the code and documentation
refer to this document, unless mentioned otherwise.

Most of the code has passed basic manual and automated tests,
but the SP code hasn't been used in a real-world application
yet.


Not supported at this time:

Service Provider:

  * parameters from Auth header (needs some parsing) [5.4]
    in principle a MUST, but as SP you get to decide ;)

  * Nonce checking [9], a SHOULD.

  * Session extension
      http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html
  
  * Problem Reporting extension
      http://oauth.pbworks.com/ProblemReporting

Consumer:

  * Auth parameters should be working, but Google rejects them for
    some reason. Do more testing and debugging.

  * Revoking tokens as per section 7 of the Session extension

  * Problem Reporting extension: fields in body are ignored.

Both:

  * crypto signatures different from HMAC-SHA1. It's easy to use
    other digests and MACs via Ironclad but RSA needs to have
    padding implemented. [9.3]

  * PLAINTEXT signature. Meh. [9.4]

  * POST and Auth requests are hardly tested yet.


People who contributed in a substantial way to this library:

  * Leslie P. Polzer : base implementation.

See also revision log for minor contributions.


TODO (apart from spec things not implemented yet):

  * grep the code for TODO and FIXME

  * incorporate test cases from http://wiki.oauth.net/TestCases

  * abstract token storage, can't get far with volatile memory
    FETCH-TOKEN/STORE-TOKEN

  * better handling of different protocol versions; in particular
    we should support serving both 1.0 and 1.0a clients (and requesting
    stuff from 1.0 and 1.0a servers too, of course).

  * compare with the Hammer draft spec and resolve differences

  * always store the URL-decoded key/secret in the request token



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-oauth

Maintainer

Leslie P. Polzer <polzer@gnu.org>

License

LLGPL

Description

Common Lisp OAuth implementation

Version

3

Dependencies
Source

cl-oauth.asd (file)

Components

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

3 Modules

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


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

3.1 cl-oauth/src

Parent

cl-oauth (system)

Location

src/

Components

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

3.2 cl-oauth/src/util

Dependency

package.lisp (file)

Parent

src (module)

Location

src/util/

Components

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

3.3 cl-oauth/src/core

Dependencies
Parent

src (module)

Location

src/core/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 cl-oauth.asd

Location

cl-oauth.asd

Systems

cl-oauth (system)

Packages

cl-oauth-asd


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

4.1.2 cl-oauth/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-oauth


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

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

Parent

util (module)

Location

src/util/misc.lisp

Internal Definitions

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

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

Dependency

misc.lisp (file)

Parent

util (module)

Location

src/util/query-string.lisp

Internal Definitions

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

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

Dependency

query-string.lisp (file)

Parent

util (module)

Location

src/util/uri.lisp

Exported Definitions

url-encode (function)

Internal Definitions

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

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

Parent

core (module)

Location

src/core/crypto.lisp

Exported Definitions

hmac-sha1 (function)

Internal Definitions

string-or-octets->octets (function)


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

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

Parent

core (module)

Location

src/core/request-adapter.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

request-adapter.lisp (file)

Parent

core (module)

Location

src/core/error-handling.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

request-adapter.lisp (file)

Parent

core (module)

Location

src/core/parameters.lisp

Exported Definitions
Internal Definitions

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

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

Parent

core (module)

Location

src/core/signature.lisp

Exported Definitions

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

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

Dependency

signature.lisp (file)

Parent

core (module)

Location

src/core/tokens.lisp

Exported Definitions
Internal Definitions

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

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

Dependencies
Parent

core (module)

Location

src/core/consumer.lisp

Exported Definitions
Internal Definitions

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

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

Dependencies
Parent

core (module)

Location

src/core/service-provider.lisp

Exported Definitions
Internal Definitions

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

4.2 Other


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

4.2.1 cl-oauth/cl-oauth.asd

Parent

cl-oauth (system)

Location

cl-oauth.asd


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

5 Packages

Packages are listed by definition order.


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

5.1 cl-oauth-asd

Source

cl-oauth.asd

Use List

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

5.2 cl-oauth

Source

package.lisp (file)

Nickname

oauth

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 Special variables

Special Variable: *protocol-version*
Package

cl-oauth

Source

service-provider.lisp (file)

Special Variable: *request*

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

Package

cl-oauth

Source

request-adapter.lisp (file)

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 (file)


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

6.1.2 Macros

Macro: protocol-assert &body BODY
Package

cl-oauth

Source

error-handling.lisp (file)


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

6.1.3 Functions

Function: abort-request RESULT

Return the string RESULT immediately from the request handler.

Package

cl-oauth

Source

request-adapter.lisp (file)

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 (file)

Function: access-token-expired-p ACCESS-TOKEN
Package

cl-oauth

Source

tokens.lisp (file)

Function: auth-parameters &optional REQUEST
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: authorize-request-token REQUEST-TOKEN

Authorize a request token explicitly. Returns the authorized token.

Package

cl-oauth

Source

consumer.lisp (file)

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 (file)

Function: check-nonce-and-timestamp CONSUMER-TOKEN
Package

cl-oauth

Source

service-provider.lisp (file)

Function: check-signature ()
Package

cl-oauth

Source

service-provider.lisp (file)

Function: check-verification-code ()
Package

cl-oauth

Source

service-provider.lisp (file)

Function: check-version ()
Package

cl-oauth

Source

service-provider.lisp (file)

Function: default-error-handler CONDITION

Default error handler for conditions of type HTTP-ERROR.

Package

cl-oauth

Source

error-handling.lisp (file)

Function: encode-signature OCTETS URL-ENCODE-P

9.2.1

Package

cl-oauth

Source

signature.lisp (file)

Function: finalize-callback-uri REQUEST-TOKEN

Prepares the callback URI of REQUEST-TOKEN for redirection.

Package

cl-oauth

Source

service-provider.lisp (file)

Function: get-parameters &optional REQUEST
Package

cl-oauth

Source

request-adapter.lisp (file)

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 (file)

Function: hmac-key CONSUMER-SECRET &optional TOKEN-SECRET

9.2

Package

cl-oauth

Source

signature.lisp (file)

Function: hmac-sha1 S KEY
Package

cl-oauth

Source

crypto.lisp (file)

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

cl-oauth

Source

request-adapter.lisp (file)

Function: make-access-token &rest ARGS
Package

cl-oauth

Source

tokens.lisp (file)

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 (file)

Function: make-consumer-token &rest ARGS
Package

cl-oauth

Source

tokens.lisp (file)

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

cl-oauth

Source

request-adapter.lisp (file)

Function: make-request-adapter &key (REQUEST-OBJECT-FN REQUEST-OBJECT-FN) (REQUEST-METHOD-FN REQUEST-METHOD-FN) (REQUEST-URI-FN REQUEST-URI-FN) (ABORT-REQUEST-FN ABORT-REQUEST-FN) (AUTH-PARAMETERS-FN AUTH-PARAMETERS-FN) (POST-PARAMETERS-FN POST-PARAMETERS-FN) (GET-PARAMETERS-FN GET-PARAMETERS-FN)
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: make-request-token &rest ARGS
Package

cl-oauth

Source

tokens.lisp (file)

Function: make-response ALIST

[5.3]

Package

cl-oauth

Source

service-provider.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: post-parameters &optional REQUEST
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: raise-error TYPE &optional REASON-PHRASE-FMT &rest REASON-PHRASE-ARGS
Package

cl-oauth

Source

error-handling.lisp (file)

Function: request ()
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-method &optional REQUEST
Package

cl-oauth

Source

request-adapter.lisp (file)

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 (file)

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 (file)

Function: signature-base-string &key URI REQUEST-METHOD PARAMETERS
Package

cl-oauth

Source

signature.lisp (file)

Function: sort-parameters PARAMETERS

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

Package

cl-oauth

Source

parameters.lisp (file)

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 (file)

Function: validate-access-token ()
Package

cl-oauth

Source

service-provider.lisp (file)

Function: validate-access-token-request &key ACCESS-TOKEN-CTOR
Package

cl-oauth

Source

service-provider.lisp (file)

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 (file)


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

6.1.4 Generic functions

Generic Function: access-token-authorization-expires OBJECT
Package

cl-oauth

Methods
Method: access-token-authorization-expires (ACCESS-TOKEN access-token)

Universal time when this token’s session expires.

Source

tokens.lisp (file)

Generic Function: access-token-expires OBJECT
Package

cl-oauth

Methods
Method: access-token-expires (ACCESS-TOKEN access-token)

Universal time when this token expires.

Source

tokens.lisp (file)

Generic Function: access-token-session-handle OBJECT
Package

cl-oauth

Methods
Method: access-token-session-handle (ACCESS-TOKEN access-token)

automatically generated reader method

Source

tokens.lisp (file)

Generic Function: register-token TOKEN
Package

cl-oauth

Methods
Method: register-token (TOKEN access-token)
Source

service-provider.lisp (file)

Method: register-token (TOKEN request-token)
Source

service-provider.lisp (file)

Method: register-token (TOKEN consumer-token)
Source

service-provider.lisp (file)

Generic Function: request-token-authorized-p OBJECT
Generic Function: (setf request-token-authorized-p) NEW-VALUE OBJECT
Package

cl-oauth

Methods
Method: request-token-authorized-p (REQUEST-TOKEN request-token)

automatically generated reader method

Source

tokens.lisp (file)

Method: (setf request-token-authorized-p) NEW-VALUE (REQUEST-TOKEN request-token)

automatically generated writer method

Source

tokens.lisp (file)

Generic Function: request-token-callback-uri OBJECT
Package

cl-oauth

Methods
Method: request-token-callback-uri (REQUEST-TOKEN request-token)

Callback URI for this request token. NIL means oob.

Source

tokens.lisp (file)

Generic Function: request-token-verification-code OBJECT
Generic Function: (setf request-token-verification-code) NEW-VALUE OBJECT
Package

cl-oauth

Methods
Method: request-token-verification-code (REQUEST-TOKEN request-token)
Method: (setf request-token-verification-code) NEW-VALUE (REQUEST-TOKEN request-token)

Might be NIL for OAuth 1.0

Source

tokens.lisp (file)

Generic Function: token-consumer OBJECT
Generic Function: (setf token-consumer) NEW-VALUE OBJECT
Package

cl-oauth

Methods
Method: token-consumer (CONSUMER-REF-MIXIN consumer-ref-mixin)
Method: (setf token-consumer) NEW-VALUE (CONSUMER-REF-MIXIN consumer-ref-mixin)

The Consumer that originally requested this token.

Source

tokens.lisp (file)

Generic Function: token-key OBJECT
Package

cl-oauth

Methods
Method: token-key (TOKEN token)

automatically generated reader method

Source

tokens.lisp (file)

Generic Function: token-secret OBJECT
Package

cl-oauth

Methods
Method: token-secret (TOKEN token)

automatically generated reader method

Source

tokens.lisp (file)

Generic Function: token-user-data OBJECT
Generic Function: (setf token-user-data) NEW-VALUE OBJECT
Package

cl-oauth

Methods
Method: token-user-data (TOKEN token)
Method: (setf token-user-data) NEW-VALUE (TOKEN token)

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

Source

tokens.lisp (file)

Generic Function: unregister-token TOKEN
Package

cl-oauth

Methods
Method: unregister-token (TOKEN access-token)
Source

service-provider.lisp (file)

Method: unregister-token (TOKEN request-token)
Source

service-provider.lisp (file)

Method: unregister-token (TOKEN consumer-token)
Source

service-provider.lisp (file)


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

6.1.5 Conditions

Condition: bad-request ()
Package

cl-oauth

Source

error-handling.lisp (file)

Direct superclasses

http-error (condition)

Direct Default Initargs
InitargValue
:reason-phrase"bad request"
:status-code400
Condition: http-error ()
Package

cl-oauth

Source

error-handling.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: status-code
Initargs

:status-code

Readers

http-error-status-code (generic function)

Slot: reason-phrase
Initargs

:reason-phrase

Readers

http-error-reason-phrase (generic function)

Condition: unauthorized ()
Package

cl-oauth

Source

error-handling.lisp (file)

Direct superclasses

http-error (condition)

Direct Default Initargs
InitargValue
:reason-phrase"unauthorized"
:status-code401

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

6.1.6 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

cl-oauth

Source

request-adapter.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: request-object-fn
Type

(or function symbol null)

Readers

request-adapter-request-object-fn (function)

Writers

(setf request-adapter-request-object-fn) (function)

Slot: request-method-fn
Type

(or function symbol null)

Readers

request-adapter-request-method-fn (function)

Writers

(setf request-adapter-request-method-fn) (function)

Slot: request-uri-fn
Type

(or function symbol null)

Readers

request-adapter-request-uri-fn (function)

Writers

(setf request-adapter-request-uri-fn) (function)

Slot: abort-request-fn
Type

(or function symbol null)

Readers

request-adapter-abort-request-fn (function)

Writers

(setf request-adapter-abort-request-fn) (function)

Slot: auth-parameters-fn
Type

(or function symbol null)

Readers

request-adapter-auth-parameters-fn (function)

Writers

(setf request-adapter-auth-parameters-fn) (function)

Slot: post-parameters-fn
Type

(or function symbol null)

Readers

request-adapter-post-parameters-fn (function)

Writers

(setf request-adapter-post-parameters-fn) (function)

Slot: get-parameters-fn
Type

(or function symbol null)

Readers

request-adapter-get-parameters-fn (function)

Writers

(setf request-adapter-get-parameters-fn) (function)


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

6.1.7 Classes

Class: access-token ()
Package

cl-oauth

Source

tokens.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: session-handle
Type

(or string null)

Initargs

:session-handle

Readers

access-token-session-handle (generic function)

Slot: expires

Universal time when this token expires.

Type

(or integer null)

Initargs

:expires

Readers

access-token-expires (generic function)

Slot: authorization-expires

Universal time when this token’s session expires.

Type

(or integer null)

Initargs

:authorization-expires

Readers

access-token-authorization-expires (generic function)

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 (generic function)

Class: consumer-token ()
Package

cl-oauth

Source

tokens.lisp (file)

Direct superclasses

token (class)

Direct methods
Direct slots
Slot: last-timestamp
Type

integer

Initform

0

Readers

consumer-token-last-timestamp (generic function)

Writers

(setf consumer-token-last-timestamp) (generic function)

Class: request-token ()
Package

cl-oauth

Source

tokens.lisp (file)

Direct superclasses
Direct methods
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 (generic function)

Slot: verification-code

Might be NIL for OAuth 1.0

Type

(or string null)

Initargs

:verification-code

Initform

(cl-oauth::random-verification-code)

Readers

request-token-verification-code (generic function)

Writers

(setf request-token-verification-code) (generic function)

Slot: authorized-p
Type

boolean

Readers

request-token-authorized-p (generic function)

Writers

(setf request-token-authorized-p) (generic function)

Class: token ()
Package

cl-oauth

Source

tokens.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: key
Type

string

Initargs

:key

Initform

(cl-oauth::random-key)

Readers

token-key (generic function)

Slot: secret
Type

string

Initargs

:secret

Initform

(cl-oauth::random-secret)

Readers

token-secret (generic function)

Slot: user-data

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

Type

list

Initargs

:user-data

Readers

token-user-data (generic function)

Writers

(setf token-user-data) (generic function)


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

6.2 Internal definitions


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

6.2.1 Constants

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

cl-oauth

Source

misc.lisp (file)


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

6.2.2 Special variables

Special Variable: *issued-access-tokens*
Package

cl-oauth

Source

service-provider.lisp (file)

Special Variable: *issued-request-tokens*
Package

cl-oauth

Source

service-provider.lisp (file)

Special Variable: *parameters-cache*

Per-request cache for parameters in OAuth requests.

Package

cl-oauth

Source

parameters.lisp (file)

Special Variable: *registered-consumers*
Package

cl-oauth

Source

service-provider.lisp (file)

Special Variable: *signature-cache*

Per-request cache for signatures in OAuth requests.

Package

cl-oauth

Source

parameters.lisp (file)

Special Variable: +utf-8+
Package

cl-oauth

Source

uri.lisp (file)


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

6.2.3 Macros

Macro: ignore-oauth-errors &body BODY
Package

cl-oauth

Source

service-provider.lisp (file)

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 (file)


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

6.2.4 Functions

Function: access-token-response ACCESS-TOKEN &rest ADDITIONAL-PARAMETERS
Package

cl-oauth

Source

service-provider.lisp (file)

Function: alist->plist ALIST

Converts an alist to plist.

Package

cl-oauth

Source

misc.lisp (file)

Function: alist->query-string ALIST &key INCLUDE-LEADING-AMPERSAND URL-ENCODE
Package

cl-oauth

Source

query-string.lisp (file)

Function: between WHAT LOWER UPPER
Package

cl-oauth

Source

misc.lisp (file)

Function: build-auth-string PARAMETERS
Package

cl-oauth

Source

consumer.lisp (file)

Function: copy-request-adapter INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: generate-auth-parameters CONSUMER SIGNATURE-METHOD TIMESTAMP VERSION &optional TOKEN
Package

cl-oauth

Source

consumer.lisp (file)

Function: generate-nonce &optional SIZE
Package

cl-oauth

Source

consumer.lisp (file)

Function: get-consumer-token KEY
Package

cl-oauth

Source

service-provider.lisp (file)

Function: get-problem-report HEADERS BODY
Package

cl-oauth

Source

consumer.lisp (file)

Function: get-problem-report-from-headers HEADERS
Package

cl-oauth

Source

consumer.lisp (file)

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 (file)

Function: get-supplied-callback-uri &key ALLOW-OOB-CALLBACK-P ALLOW-NONE
Package

cl-oauth

Source

service-provider.lisp (file)

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

cl-oauth

Source

service-provider.lisp (file)

Function: get-unix-time &optional UT
Package

cl-oauth

Source

misc.lisp (file)

Function: http-request URI &key AUTH-LOCATION METHOD AUTH-PARAMETERS PARAMETERS ADDITIONAL-HEADERS DRAKMA-ARGS
Package

cl-oauth

Source

consumer.lisp (file)

Function: invalidate-request-token REQUEST-TOKEN
Package

cl-oauth

Source

service-provider.lisp (file)

Function: maybe-refresh-access-token ACCESS-TOKEN &optional ON-REFRESH
Package

cl-oauth

Source

consumer.lisp (file)

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 (file)

Function: query-string->alist QUERY-STRING
Package

cl-oauth

Source

query-string.lisp (file)

Function: random-key ()
Package

cl-oauth

Source

tokens.lisp (file)

Function: random-secret ()
Package

cl-oauth

Source

tokens.lisp (file)

Function: random-verification-code ()
Package

cl-oauth

Source

tokens.lisp (file)

Function: refresh-access-token ACCESS-TOKEN
Package

cl-oauth

Source

consumer.lisp (file)

Function: remove-oauth-parameters PARAMETERS
Package

cl-oauth

Source

parameters.lisp (file)

Function: request-adapter-abort-request-fn INSTANCE
Function: (setf request-adapter-abort-request-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-auth-parameters-fn INSTANCE
Function: (setf request-adapter-auth-parameters-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-get-parameters-fn INSTANCE
Function: (setf request-adapter-get-parameters-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-p OBJECT
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-post-parameters-fn INSTANCE
Function: (setf request-adapter-post-parameters-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-request-method-fn INSTANCE
Function: (setf request-adapter-request-method-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-request-object-fn INSTANCE
Function: (setf request-adapter-request-object-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: request-adapter-request-uri-fn INSTANCE
Function: (setf request-adapter-request-uri-fn) VALUE INSTANCE
Package

cl-oauth

Source

request-adapter.lisp (file)

Function: splice-alist ALIST
Package

cl-oauth

Source

misc.lisp (file)

Function: string-or-octets->octets X
Package

cl-oauth

Source

crypto.lisp (file)

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 (file)

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 (file)


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

6.2.5 Generic functions

Generic Function: access-token-origin-uri OBJECT
Package

cl-oauth

Methods
Method: access-token-origin-uri (ACCESS-TOKEN access-token)

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

Source

tokens.lisp (file)

Generic Function: consumer-token-last-timestamp OBJECT
Generic Function: (setf consumer-token-last-timestamp) NEW-VALUE OBJECT
Package

cl-oauth

Methods
Method: consumer-token-last-timestamp (CONSUMER-TOKEN consumer-token)

automatically generated reader method

Source

tokens.lisp (file)

Method: (setf consumer-token-last-timestamp) NEW-VALUE (CONSUMER-TOKEN consumer-token)

automatically generated writer method

Source

tokens.lisp (file)

Generic Function: http-error-reason-phrase CONDITION
Package

cl-oauth

Methods
Method: http-error-reason-phrase (CONDITION http-error)
Source

error-handling.lisp (file)

Generic Function: http-error-status-code CONDITION
Package

cl-oauth

Methods
Method: http-error-status-code (CONDITION http-error)
Source

error-handling.lisp (file)

Generic Function: normalize-uri URI
Package

cl-oauth

Methods
Method: normalize-uri (URI uri)

9.1.2

Source

uri.lisp (file)

Method: normalize-uri (URI string)
Source

uri.lisp (file)


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

6.2.6 Classes

Class: consumer-ref-mixin ()

Mixin for classes that refer to a consumer.

Package

cl-oauth

Source

tokens.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: consumer

The Consumer that originally requested this token.

Type

cl-oauth:consumer-token

Initargs

:consumer

Readers

token-consumer (generic function)

Writers

(setf token-consumer) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M   O  
Index Entry  Section

C
cl-oauth.asd: The cl-oauth<dot>asd file
cl-oauth/cl-oauth.asd: The cl-oauth/cl-oauth<dot>asd file
cl-oauth/src: The cl-oauth/src module
cl-oauth/src/core: The cl-oauth/src/core module
cl-oauth/src/core/consumer.lisp: The cl-oauth/src/core/consumer<dot>lisp file
cl-oauth/src/core/crypto.lisp: The cl-oauth/src/core/crypto<dot>lisp file
cl-oauth/src/core/error-handling.lisp: The cl-oauth/src/core/error-handling<dot>lisp file
cl-oauth/src/core/parameters.lisp: The cl-oauth/src/core/parameters<dot>lisp file
cl-oauth/src/core/request-adapter.lisp: The cl-oauth/src/core/request-adapter<dot>lisp file
cl-oauth/src/core/service-provider.lisp: The cl-oauth/src/core/service-provider<dot>lisp file
cl-oauth/src/core/signature.lisp: The cl-oauth/src/core/signature<dot>lisp file
cl-oauth/src/core/tokens.lisp: The cl-oauth/src/core/tokens<dot>lisp file
cl-oauth/src/package.lisp: The cl-oauth/src/package<dot>lisp file
cl-oauth/src/util: The cl-oauth/src/util module
cl-oauth/src/util/misc.lisp: The cl-oauth/src/util/misc<dot>lisp file
cl-oauth/src/util/query-string.lisp: The cl-oauth/src/util/query-string<dot>lisp file
cl-oauth/src/util/uri.lisp: The cl-oauth/src/util/uri<dot>lisp file

F
File, Lisp, cl-oauth.asd: The cl-oauth<dot>asd file
File, Lisp, cl-oauth/src/core/consumer.lisp: The cl-oauth/src/core/consumer<dot>lisp file
File, Lisp, cl-oauth/src/core/crypto.lisp: The cl-oauth/src/core/crypto<dot>lisp file
File, Lisp, cl-oauth/src/core/error-handling.lisp: The cl-oauth/src/core/error-handling<dot>lisp file
File, Lisp, cl-oauth/src/core/parameters.lisp: The cl-oauth/src/core/parameters<dot>lisp file
File, Lisp, cl-oauth/src/core/request-adapter.lisp: The cl-oauth/src/core/request-adapter<dot>lisp file
File, Lisp, cl-oauth/src/core/service-provider.lisp: The cl-oauth/src/core/service-provider<dot>lisp file
File, Lisp, cl-oauth/src/core/signature.lisp: The cl-oauth/src/core/signature<dot>lisp file
File, Lisp, cl-oauth/src/core/tokens.lisp: The cl-oauth/src/core/tokens<dot>lisp file
File, Lisp, cl-oauth/src/package.lisp: The cl-oauth/src/package<dot>lisp file
File, Lisp, cl-oauth/src/util/misc.lisp: The cl-oauth/src/util/misc<dot>lisp file
File, Lisp, cl-oauth/src/util/query-string.lisp: The cl-oauth/src/util/query-string<dot>lisp file
File, Lisp, cl-oauth/src/util/uri.lisp: The cl-oauth/src/util/uri<dot>lisp file
File, other, cl-oauth/cl-oauth.asd: The cl-oauth/cl-oauth<dot>asd file

L
Lisp File, cl-oauth.asd: The cl-oauth<dot>asd file
Lisp File, cl-oauth/src/core/consumer.lisp: The cl-oauth/src/core/consumer<dot>lisp file
Lisp File, cl-oauth/src/core/crypto.lisp: The cl-oauth/src/core/crypto<dot>lisp file
Lisp File, cl-oauth/src/core/error-handling.lisp: The cl-oauth/src/core/error-handling<dot>lisp file
Lisp File, cl-oauth/src/core/parameters.lisp: The cl-oauth/src/core/parameters<dot>lisp file
Lisp File, cl-oauth/src/core/request-adapter.lisp: The cl-oauth/src/core/request-adapter<dot>lisp file
Lisp File, cl-oauth/src/core/service-provider.lisp: The cl-oauth/src/core/service-provider<dot>lisp file
Lisp File, cl-oauth/src/core/signature.lisp: The cl-oauth/src/core/signature<dot>lisp file
Lisp File, cl-oauth/src/core/tokens.lisp: The cl-oauth/src/core/tokens<dot>lisp file
Lisp File, cl-oauth/src/package.lisp: The cl-oauth/src/package<dot>lisp file
Lisp File, cl-oauth/src/util/misc.lisp: The cl-oauth/src/util/misc<dot>lisp file
Lisp File, cl-oauth/src/util/query-string.lisp: The cl-oauth/src/util/query-string<dot>lisp file
Lisp File, cl-oauth/src/util/uri.lisp: The cl-oauth/src/util/uri<dot>lisp file

M
Module, cl-oauth/src: The cl-oauth/src module
Module, cl-oauth/src/core: The cl-oauth/src/core module
Module, cl-oauth/src/util: The cl-oauth/src/util module

O
Other File, cl-oauth/cl-oauth.asd: The cl-oauth/cl-oauth<dot>asd file

Jump to:   C   F   L   M   O  

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

A.2 Functions

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

(
(setf consumer-token-last-timestamp): Internal generic functions
(setf consumer-token-last-timestamp): Internal generic functions
(setf request-adapter-abort-request-fn): Internal functions
(setf request-adapter-auth-parameters-fn): Internal functions
(setf request-adapter-get-parameters-fn): Internal functions
(setf request-adapter-post-parameters-fn): Internal functions
(setf request-adapter-request-method-fn): Internal functions
(setf request-adapter-request-object-fn): Internal functions
(setf request-adapter-request-uri-fn): Internal functions
(setf request-token-authorized-p): Exported generic functions
(setf request-token-authorized-p): Exported generic functions
(setf request-token-verification-code): Exported generic functions
(setf request-token-verification-code): Exported generic functions
(setf token-consumer): Exported generic functions
(setf token-consumer): Exported generic functions
(setf token-user-data): Exported generic functions
(setf token-user-data): Exported generic functions

A
abort-request: Exported functions
access-protected-resource: Exported functions
access-token-authorization-expires: Exported generic functions
access-token-authorization-expires: Exported generic functions
access-token-expired-p: Exported functions
access-token-expires: Exported generic functions
access-token-expires: Exported generic functions
access-token-origin-uri: Internal generic functions
access-token-origin-uri: Internal generic functions
access-token-response: Internal functions
access-token-session-handle: Exported generic functions
access-token-session-handle: Exported generic functions
alist->plist: Internal functions
alist->query-string: Internal functions
auth-parameters: Exported functions
authorize-request-token: Exported functions
authorize-request-token-from-request: Exported functions

B
between: Internal functions
build-auth-string: Internal functions

C
check-nonce-and-timestamp: Exported functions
check-signature: Exported functions
check-verification-code: Exported functions
check-version: Exported functions
consumer-token-last-timestamp: Internal generic functions
consumer-token-last-timestamp: Internal generic functions
copy-request-adapter: Internal functions

D
default-error-handler: Exported functions

E
encode-signature: Exported functions

F
finalize-callback-uri: Exported functions
Function, (setf request-adapter-abort-request-fn): Internal functions
Function, (setf request-adapter-auth-parameters-fn): Internal functions
Function, (setf request-adapter-get-parameters-fn): Internal functions
Function, (setf request-adapter-post-parameters-fn): Internal functions
Function, (setf request-adapter-request-method-fn): Internal functions
Function, (setf request-adapter-request-object-fn): Internal functions
Function, (setf request-adapter-request-uri-fn): Internal functions
Function, abort-request: Exported functions
Function, access-protected-resource: Exported functions
Function, access-token-expired-p: Exported functions
Function, access-token-response: Internal functions
Function, alist->plist: Internal functions
Function, alist->query-string: Internal functions
Function, auth-parameters: Exported functions
Function, authorize-request-token: Exported functions
Function, authorize-request-token-from-request: Exported functions
Function, between: Internal functions
Function, build-auth-string: Internal functions
Function, check-nonce-and-timestamp: Exported functions
Function, check-signature: Exported functions
Function, check-verification-code: Exported functions
Function, check-version: Exported functions
Function, copy-request-adapter: Internal functions
Function, default-error-handler: Exported functions
Function, encode-signature: Exported functions
Function, finalize-callback-uri: Exported functions
Function, generate-auth-parameters: Internal functions
Function, generate-nonce: Internal functions
Function, get-consumer-token: Internal functions
Function, get-parameters: Exported functions
Function, get-problem-report: Internal functions
Function, get-problem-report-from-headers: Internal functions
Function, get-supplied-access-token: Internal functions
Function, get-supplied-callback-uri: Internal functions
Function, get-supplied-consumer-token: Internal functions
Function, get-supplied-request-token: Exported functions
Function, get-unix-time: Internal functions
Function, hmac-key: Exported functions
Function, hmac-sha1: Exported functions
Function, http-request: Internal functions
Function, init-default-request-adapter: Exported functions
Function, invalidate-request-token: Internal functions
Function, make-access-token: Exported functions
Function, make-authorization-uri: Exported functions
Function, make-consumer-token: Exported functions
Function, make-hunchentoot-request-adapter: Exported functions
Function, make-request-adapter: Exported functions
Function, make-request-token: Exported functions
Function, make-response: Exported functions
Function, maybe-refresh-access-token: Internal functions
Function, normalized-parameters: Exported functions
Function, oauth-parameter-p: Internal functions
Function, obtain-access-token: Exported functions
Function, obtain-request-token: Exported functions
Function, parameter: Exported functions
Function, post-parameters: Exported functions
Function, query-string->alist: Internal functions
Function, raise-error: Exported functions
Function, random-key: Internal functions
Function, random-secret: Internal functions
Function, random-verification-code: Internal functions
Function, refresh-access-token: Internal functions
Function, remove-oauth-parameters: Internal functions
Function, request: Exported functions
Function, request-adapter-abort-request-fn: Internal functions
Function, request-adapter-auth-parameters-fn: Internal functions
Function, request-adapter-get-parameters-fn: Internal functions
Function, request-adapter-p: Internal functions
Function, request-adapter-post-parameters-fn: Internal functions
Function, request-adapter-request-method-fn: Internal functions
Function, request-adapter-request-object-fn: Internal functions
Function, request-adapter-request-uri-fn: Internal functions
Function, request-method: Exported functions
Function, request-token-response: Exported functions
Function, request-uri: Exported functions
Function, signature-base-string: Exported functions
Function, sort-parameters: Exported functions
Function, splice-alist: Internal functions
Function, string-or-octets->octets: Internal functions
Function, uri-with-additional-query-part: Internal functions
Function, url-decode: Internal functions
Function, url-encode: Exported functions
Function, validate-access-token: Exported functions
Function, validate-access-token-request: Exported functions
Function, validate-request-token-request: Exported functions

G
generate-auth-parameters: Internal functions
generate-nonce: Internal functions
Generic Function, (setf consumer-token-last-timestamp): Internal generic functions
Generic Function, (setf request-token-authorized-p): Exported generic functions
Generic Function, (setf request-token-verification-code): Exported generic functions
Generic Function, (setf token-consumer): Exported generic functions
Generic Function, (setf token-user-data): Exported generic functions
Generic Function, access-token-authorization-expires: Exported generic functions
Generic Function, access-token-expires: Exported generic functions
Generic Function, access-token-origin-uri: Internal generic functions
Generic Function, access-token-session-handle: Exported generic functions
Generic Function, consumer-token-last-timestamp: Internal generic functions
Generic Function, http-error-reason-phrase: Internal generic functions
Generic Function, http-error-status-code: Internal generic functions
Generic Function, normalize-uri: Internal generic functions
Generic Function, register-token: Exported generic functions
Generic Function, request-token-authorized-p: Exported generic functions
Generic Function, request-token-callback-uri: Exported generic functions
Generic Function, request-token-verification-code: Exported generic functions
Generic Function, token-consumer: Exported generic functions
Generic Function, token-key: Exported generic functions
Generic Function, token-secret: Exported generic functions
Generic Function, token-user-data: Exported generic functions
Generic Function, unregister-token: Exported generic functions
get-consumer-token: Internal functions
get-parameters: Exported functions
get-problem-report: Internal functions
get-problem-report-from-headers: Internal functions
get-supplied-access-token: Internal functions
get-supplied-callback-uri: Internal functions
get-supplied-consumer-token: Internal functions
get-supplied-request-token: Exported functions
get-unix-time: Internal functions

H
hmac-key: Exported functions
hmac-sha1: Exported functions
http-error-reason-phrase: Internal generic functions
http-error-reason-phrase: Internal generic functions
http-error-status-code: Internal generic functions
http-error-status-code: Internal generic functions
http-request: Internal functions

I
ignore-oauth-errors: Internal macros
init-default-request-adapter: Exported functions
invalidate-request-token: Internal functions

M
Macro, ignore-oauth-errors: Internal macros
Macro, protocol-assert: Exported macros
Macro, upgrade-vector: Internal macros
make-access-token: Exported functions
make-authorization-uri: Exported functions
make-consumer-token: Exported functions
make-hunchentoot-request-adapter: Exported functions
make-request-adapter: Exported functions
make-request-token: Exported functions
make-response: Exported functions
maybe-refresh-access-token: Internal functions
Method, (setf consumer-token-last-timestamp): Internal generic functions
Method, (setf request-token-authorized-p): Exported generic functions
Method, (setf request-token-verification-code): Exported generic functions
Method, (setf token-consumer): Exported generic functions
Method, (setf token-user-data): Exported generic functions
Method, access-token-authorization-expires: Exported generic functions
Method, access-token-expires: Exported generic functions
Method, access-token-origin-uri: Internal generic functions
Method, access-token-session-handle: Exported generic functions
Method, consumer-token-last-timestamp: Internal generic functions
Method, http-error-reason-phrase: Internal generic functions
Method, http-error-status-code: Internal generic functions
Method, normalize-uri: Internal generic functions
Method, normalize-uri: Internal generic functions
Method, register-token: Exported generic functions
Method, register-token: Exported generic functions
Method, register-token: Exported generic functions
Method, request-token-authorized-p: Exported generic functions
Method, request-token-callback-uri: Exported generic functions
Method, request-token-verification-code: Exported generic functions
Method, token-consumer: Exported generic functions
Method, token-key: Exported generic functions
Method, token-secret: Exported generic functions
Method, token-user-data: Exported generic functions
Method, unregister-token: Exported generic functions
Method, unregister-token: Exported generic functions
Method, unregister-token: Exported generic functions

N
normalize-uri: Internal generic functions
normalize-uri: Internal generic functions
normalize-uri: Internal generic functions
normalized-parameters: Exported functions

O
oauth-parameter-p: Internal functions
obtain-access-token: Exported functions
obtain-request-token: Exported functions

P
parameter: Exported functions
post-parameters: Exported functions
protocol-assert: Exported macros

Q
query-string->alist: Internal functions

R
raise-error: Exported functions
random-key: Internal functions
random-secret: Internal functions
random-verification-code: Internal functions
refresh-access-token: Internal functions
register-token: Exported generic functions
register-token: Exported generic functions
register-token: Exported generic functions
register-token: Exported generic functions
remove-oauth-parameters: Internal functions
request: Exported functions
request-adapter-abort-request-fn: Internal functions
request-adapter-auth-parameters-fn: Internal functions
request-adapter-get-parameters-fn: Internal functions
request-adapter-p: Internal functions
request-adapter-post-parameters-fn: Internal functions
request-adapter-request-method-fn: Internal functions
request-adapter-request-object-fn: Internal functions
request-adapter-request-uri-fn: Internal functions
request-method: Exported functions
request-token-authorized-p: Exported generic functions
request-token-authorized-p: Exported generic functions
request-token-callback-uri: Exported generic functions
request-token-callback-uri: Exported generic functions
request-token-response: Exported functions
request-token-verification-code: Exported generic functions
request-token-verification-code: Exported generic functions
request-uri: Exported functions

S
signature-base-string: Exported functions
sort-parameters: Exported functions
splice-alist: Internal functions
string-or-octets->octets: Internal functions

T
token-consumer: Exported generic functions
token-consumer: Exported generic functions
token-key: Exported generic functions
token-key: Exported generic functions
token-secret: Exported generic functions
token-secret: Exported generic functions
token-user-data: Exported generic functions
token-user-data: Exported generic functions

U
unregister-token: Exported generic functions
unregister-token: Exported generic functions
unregister-token: Exported generic functions
unregister-token: Exported generic functions
upgrade-vector: Internal macros
uri-with-additional-query-part: Internal functions
url-decode: Internal functions
url-encode: Exported functions

V
validate-access-token: Exported functions
validate-access-token-request: Exported functions
validate-request-token-request: Exported functions

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

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

A.3 Variables

Jump to:   *   +  
A   C   E   G   K   L   O   P   R   S   U   V  
Index Entry  Section

*
*issued-access-tokens*: Internal special variables
*issued-request-tokens*: Internal special variables
*parameters-cache*: Internal special variables
*protocol-version*: Exported special variables
*registered-consumers*: Internal special variables
*request*: Exported special variables
*request-adapter*: Exported special variables
*signature-cache*: Internal special variables

+
+unix-to-universal-time+: Internal constants
+utf-8+: Internal special variables

A
abort-request-fn: Exported structures
auth-parameters-fn: Exported structures
authorization-expires: Exported classes
authorized-p: Exported classes

C
callback-uri: Exported classes
Constant, +unix-to-universal-time+: Internal constants
consumer: Internal classes

E
expires: Exported classes

G
get-parameters-fn: Exported structures

K
key: Exported classes

L
last-timestamp: Exported classes

O
origin-uri: Exported classes

P
post-parameters-fn: Exported structures

R
reason-phrase: Exported conditions
request-method-fn: Exported structures
request-object-fn: Exported structures
request-uri-fn: Exported structures

S
secret: Exported classes
session-handle: Exported classes
Slot, abort-request-fn: Exported structures
Slot, auth-parameters-fn: Exported structures
Slot, authorization-expires: Exported classes
Slot, authorized-p: Exported classes
Slot, callback-uri: Exported classes
Slot, consumer: Internal classes
Slot, expires: Exported classes
Slot, get-parameters-fn: Exported structures
Slot, key: Exported classes
Slot, last-timestamp: Exported classes
Slot, origin-uri: Exported classes
Slot, post-parameters-fn: Exported structures
Slot, reason-phrase: Exported conditions
Slot, request-method-fn: Exported structures
Slot, request-object-fn: Exported structures
Slot, request-uri-fn: Exported structures
Slot, secret: Exported classes
Slot, session-handle: Exported classes
Slot, status-code: Exported conditions
Slot, user-data: Exported classes
Slot, verification-code: Exported classes
Special Variable, *issued-access-tokens*: Internal special variables
Special Variable, *issued-request-tokens*: Internal special variables
Special Variable, *parameters-cache*: Internal special variables
Special Variable, *protocol-version*: Exported special variables
Special Variable, *registered-consumers*: Internal special variables
Special Variable, *request*: Exported special variables
Special Variable, *request-adapter*: Exported special variables
Special Variable, *signature-cache*: Internal special variables
Special Variable, +utf-8+: Internal special variables
status-code: Exported conditions

U
user-data: Exported classes

V
verification-code: Exported classes

Jump to:   *   +  
A   C   E   G   K   L   O   P   R   S   U   V  

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

A.4 Data types

Jump to:   A   B   C   H   P   R   S   T   U  
Index Entry  Section

A
access-token: Exported classes

B
bad-request: Exported conditions

C
cl-oauth: The cl-oauth system
cl-oauth: The cl-oauth package
cl-oauth-asd: The cl-oauth-asd package
Class, access-token: Exported classes
Class, consumer-ref-mixin: Internal classes
Class, consumer-token: Exported classes
Class, request-token: Exported classes
Class, token: Exported classes
Condition, bad-request: Exported conditions
Condition, http-error: Exported conditions
Condition, unauthorized: Exported conditions
consumer-ref-mixin: Internal classes
consumer-token: Exported classes

H
http-error: Exported conditions

P
Package, cl-oauth: The cl-oauth package
Package, cl-oauth-asd: The cl-oauth-asd package

R
request-adapter: Exported structures
request-token: Exported classes

S
Structure, request-adapter: Exported structures
System, cl-oauth: The cl-oauth system

T
token: Exported classes

U
unauthorized: Exported conditions

Jump to:   A   B   C   H   P   R   S   T   U