This is the cl-oauth Reference Manual, version 3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:13:25 2024 GMT+0.
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
The main system appears first, followed by any subsystem dependency.
cl-oauth
Common Lisp OAuth implementation
Leslie P. Polzer <polzer@gnu.org>
LLGPL
3
ironclad
(system).
cl-base64
(system).
babel
(system).
closer-mop
(system).
alexandria
(system).
anaphora
(system).
f-underscore
(system).
split-sequence
(system).
trivial-garbage
(system).
drakma
(system).
puri
(system).
hunchentoot
(system).
src
(module).
Modules are listed depth-first from the system components tree.
cl-oauth/src
cl-oauth
(system).
package.lisp
(file).
util
(module).
core
(module).
cl-oauth/src/util
package.lisp
(file).
src
(module).
misc.lisp
(file).
query-string.lisp
(file).
uri.lisp
(file).
cl-oauth/src/core
package.lisp
(file).
util
(module).
src
(module).
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).
Files are sorted by type and then listed depth-first from the systems components trees.
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
cl-oauth/src/util/misc.lisp
util
(module).
+unix-to-universal-time+
(constant).
alist->plist
(function).
between
(function).
get-unix-time
(function).
splice-alist
(function).
cl-oauth/src/util/query-string.lisp
misc.lisp
(file).
util
(module).
alist->query-string
(function).
query-string->alist
(function).
cl-oauth/src/util/uri.lisp
query-string.lisp
(file).
util
(module).
url-encode
(function).
+utf-8+
(special variable).
normalize-uri
(method).
normalize-uri
(method).
upgrade-vector
(macro).
url-decode
(function).
cl-oauth/src/core/crypto.lisp
core
(module).
hmac-sha1
(function).
string-or-octets->octets
(function).
cl-oauth/src/core/request-adapter.lisp
core
(module).
*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).
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).
cl-oauth/src/core/error-handling.lisp
request-adapter.lisp
(file).
core
(module).
bad-request
(condition).
default-error-handler
(function).
http-error
(condition).
protocol-assert
(macro).
raise-error
(function).
unauthorized
(condition).
http-error-reason-phrase
(reader method).
http-error-status-code
(reader method).
cl-oauth/src/core/parameters.lisp
request-adapter.lisp
(file).
core
(module).
normalized-parameters
(function).
parameter
(function).
sort-parameters
(function).
*parameters-cache*
(special variable).
*signature-cache*
(special variable).
oauth-parameter-p
(function).
remove-oauth-parameters
(function).
cl-oauth/src/core/signature.lisp
core
(module).
encode-signature
(function).
hmac-key
(function).
signature-base-string
(function).
cl-oauth/src/core/tokens.lisp
signature.lisp
(file).
core
(module).
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).
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).
cl-oauth/src/core/consumer.lisp
tokens.lisp
(file).
parameters.lisp
(file).
error-handling.lisp
(file).
core
(module).
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).
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).
cl-oauth/src/core/service-provider.lisp
tokens.lisp
(file).
parameters.lisp
(file).
error-handling.lisp
(file).
core
(module).
*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).
*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).
Packages are listed by definition order.
cl-oauth
oauth
anaphora
.
common-lisp
.
f-underscore
.
*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).
*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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
User-supplied request override. Only if you know what you’re doing.
Set this variable to an instance of REQUEST-ADAPTER tailored to your web server.
Return the string RESULT immediately from the request handler.
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.
Authorize a request token explicitly. Returns the authorized token.
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.
Default error handler for conditions of type HTTP-ERROR.
9.2.1
Prepares the callback URI of REQUEST-TOKEN for redirection.
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.
9.2
Return the service provider’s authorization URI. Use the resulting PURI for a redirect. [6.2.1] in 1.0.
[5.3]
Collect request parameters and remove those excluded by the standard. See 9.1.1. Note: REMOVE-DUPLICATES-P has no effect right now.
Additional parameters will be stored in the USER-DATA slot of the token. POST is recommended as request method. [6.3.1]
Additional parameters will be stored in the USER-DATA slot of the token.
Note: OAuth parameters are case-sensitive per section 5. The case of user-supplied parameters is not restricted.
Respond to a valid request token request. [6.1.2]
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).
Sort PARAMETERS according to the OAuth spec. This is a destructive operation.
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.
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]
access-token
)) ¶Universal time when this token’s session expires.
access-token
)) ¶Universal time when this token expires.
access-token
)) ¶automatically generated reader method
access-token
)) ¶request-token
)) ¶consumer-token
)) ¶request-token
)) ¶automatically generated reader method
request-token
)) ¶automatically generated writer method
request-token
)) ¶Callback URI for this request token. NIL means oob.
request-token
)) ¶request-token
)) ¶Might be NIL for OAuth 1.0
consumer-ref-mixin
)) ¶consumer-ref-mixin
)) ¶The Consumer that originally requested this token.
access-token
)) ¶request-token
)) ¶consumer-token
)) ¶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.
Initarg | Value |
---|---|
:reason-phrase | bad request |
:status-code | 400 |
Initarg | Value |
---|---|
:reason-phrase | unauthorized |
:status-code | 401 |
An adapter for server-specific parts of OAuth.
The return value of REQUEST-OBJECT-FN must be comparable with EQ.
structure-object
.
(or function symbol null)
(or function symbol null)
(or function symbol null)
(or function symbol null)
(or function symbol null)
(or function symbol null)
(or function symbol null)
(or string null)
:session-handle
This slot is read-only.
Universal time when this token expires.
(or integer null)
:expires
This slot is read-only.
Universal time when this token’s session expires.
(or integer null)
:authorization-expires
This slot is read-only.
URI this access token has been obtained from. Needed for refresh.
(or puri:uri string null)
:origin-uri
This slot is read-only.
integer
0
Callback URI for this request token. NIL means oob.
(or puri:uri null)
:callback-uri
This slot is read-only.
Might be NIL for OAuth 1.0
(or string null)
(cl-oauth::random-verification-code)
:verification-code
boolean
string
(cl-oauth::random-key)
:key
This slot is read-only.
string
(cl-oauth::random-secret)
:secret
This slot is read-only.
Application-specific data associated with this token; an alist.
list
:user-data
Per-request cache for parameters in OAuth requests.
Per-request cache for signatures in OAuth requests.
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.
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.
Return T if PARAMETER starts with "oauth_". PARAMETER is a string denoting the parameter name.
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.
Decodes a URL-encoded STRING which is assumed to be encoded using the external format EXTERNAL-FORMAT.
access-token
)) ¶URI this access token has been obtained from. Needed for refresh.
consumer-token
)) ¶automatically generated reader method
consumer-token
)) ¶automatically generated writer method
http-error
)) ¶http-error
)) ¶Jump to: | (
A B C D E F G H I M N O P Q R S T U V |
---|
Jump to: | (
A B C D E F G H I M N O P Q R S T U V |
---|
Jump to: | *
+
A C E G K L O P R S U V |
---|
Jump to: | *
+
A C E G K L O P R S U V |
---|
Jump to: | A B C E F H M P Q R S T U |
---|
Jump to: | A B C E F H M P Q R S T U |
---|