This is the south Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 07:29:55 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
southSimple OaUTH library for oAuth1.0
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/south.git)
zlib
0.3.0
drakma (system).
uuid (system).
ironclad (system).
cl-ppcre (system).
package.lisp (file).
toolkit.lisp (file).
oauth.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
south/toolkit.lisppackage.lisp (file).
south (system).
*external-format* (special variable).
generate-nonce (function).
url-decode (function).
url-encode (function).
+unix-epoch-difference+ (constant).
get-unix-time (function).
hmac (function).
parse-boolean (function).
to-keyword (function).
south/oauth.lisptoolkit.lisp (file).
south (system).
*authentication-callback* (special variable).
*oauth-access-secret* (special variable).
*oauth-access-token* (special variable).
*oauth-api-key* (special variable).
*oauth-api-secret* (special variable).
*oauth-signature-method* (special variable).
*oauth-verifier-location* (special variable).
*oauth-version* (special variable).
*oauth/access-token* (special variable).
*oauth/authenticate* (special variable).
*oauth/authorize* (special variable).
*oauth/request-token* (special variable).
*server-port* (special variable).
complete-authentication (function).
http-body (reader method).
(setf http-body) (writer method).
http-headers (reader method).
(setf http-headers) (writer method).
http-status (reader method).
(setf http-status) (writer method).
initiate-authentication (function).
initiate-server-authentication (function).
oauth-error (condition).
oauth-parameter-missing (condition).
oauth-request-error (condition).
oauth/access-token (function).
oauth/authenticate (function).
oauth/authorize (function).
oauth/request-token (function).
parameter (reader method).
(setf parameter) (writer method).
pin-request-token (function).
prepare (function).
reset (function).
signed-data-parameters-request (function).
signed-data-request (function).
signed-request (function).
signed-stream-request (function).
target-headers (reader method).
(setf target-headers) (writer method).
target-method (reader method).
(setf target-method) (writer method).
target-parameters (reader method).
(setf target-parameters) (writer method).
target-url (reader method).
(setf target-url) (writer method).
with-oauth-environment (macro).
authorization-format-parameter (function).
create-authorization-header (function).
create-authorization-header-value (function).
create-signature (function).
make-signed (function).
oauth-response->alist (function).
prepare-data-parameters (function).
request-wrapper (function).
signature-format-parameter (function).
Packages are listed by definition order.
southorg.tymoonnext.south
common-lisp.
*authentication-callback* (special variable).
*external-format* (special variable).
*oauth-access-secret* (special variable).
*oauth-access-token* (special variable).
*oauth-api-key* (special variable).
*oauth-api-secret* (special variable).
*oauth-signature-method* (special variable).
*oauth-verifier-location* (special variable).
*oauth-version* (special variable).
*oauth/access-token* (special variable).
*oauth/authenticate* (special variable).
*oauth/authorize* (special variable).
*oauth/request-token* (special variable).
*server-port* (special variable).
complete-authentication (function).
generate-nonce (function).
http-body (generic reader).
(setf http-body) (generic writer).
http-headers (generic reader).
(setf http-headers) (generic writer).
http-status (generic reader).
(setf http-status) (generic writer).
initiate-authentication (function).
initiate-server-authentication (function).
oauth-error (condition).
oauth-parameter-missing (condition).
oauth-request-error (condition).
oauth/access-token (function).
oauth/authenticate (function).
oauth/authorize (function).
oauth/request-token (function).
parameter (generic reader).
(setf parameter) (generic writer).
pin-request-token (function).
prepare (function).
reset (function).
signed-data-parameters-request (function).
signed-data-request (function).
signed-request (function).
signed-stream-request (function).
target-headers (generic reader).
(setf target-headers) (generic writer).
target-method (generic reader).
(setf target-method) (generic writer).
target-parameters (generic reader).
(setf target-parameters) (generic writer).
target-url (generic reader).
(setf target-url) (generic writer).
url-decode (function).
url-encode (function).
with-oauth-environment (macro).
+unix-epoch-difference+ (constant).
authorization-format-parameter (function).
create-authorization-header (function).
create-authorization-header-value (function).
create-signature (function).
get-unix-time (function).
hmac (function).
make-signed (function).
oauth-response->alist (function).
parse-boolean (function).
prepare-data-parameters (function).
request-wrapper (function).
signature-format-parameter (function).
to-keyword (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Function called when COMPLETE-AUTHENTICATION is called.
Two arguments are passed, the ACCESS-TOKEN and the ACCESS-SECRET.
The external format used for encoding/decoding.
Establishes an environment for all oauth related special variables.
Unless a non-NIL value is provided for a parameter it is bound to the current value of the according special variable.
Finishes the authentication procedure by retrieving the access token. Sets the *OAUTH-TOKEN* and *OAUTH-TOKEN-SECRET* to their respective values.
Generate a NONCE to use for requests. Currently this simply uses a v4-UUID.
Starts the authentication process and returns an URL that the user has to visit.
METHOD can be one of :PIN :SERVER or a string designating a callback URL.
Note that the :PIN method is NOT STANDARD and thus might not be available for your service.
See OAUTH/AUTHORIZE, INITIATE-SERVER-AUTHENTICATION and OAUTH/AUTHENTICATE respectively.
Initiate the authentication through the server mechanism. This is the same as the redirect mechanism, except it starts up a Hunchentoot server automatically and handles the callback for you. The server will be started on *SERVER-PORT* and will be shut down automatically after a single request.
Turn the tokens received through the authentication into an access token.
According to spec https://dev.twitter.com/docs/auth/implementing-sign-twitter
Initiate the authentication through the redirect mechanism.
Returns an URL that the user has to open in the browser.
Upon successful authentication, the page should redirect back
to the specified callback url. This callback endpoint should then
pass the proper parameters to COMPLETE-AUTHENTICATION.
According to spec https://dev.twitter.com/docs/auth/implementing-sign-twitter
Initiate the authentication through the PIN mechanism.
Returns an URL that the user has to open in the browser.
This page should, upon successful authentication, return a PIN
that has to be initialized by passing it to COMPLETE-AUTHENTICATION.
According to spec https://dev.twitter.com/docs/auth/pin-based-authorization
Query for a request token using the specified callback.
Returns an ALIST containing :OAUTH-TOKEN, :OAUTH-TOKEN-SECRET and
:OAUTH-CALLBACK-CONFIRMED, the first two being strings and the last a boolean.
According to spec https://dev.twitter.com/docs/auth/implementing-sign-twitter
Query for a PIN based request token.
Seee CALLBACK-REQUEST-TOKEN.
According to spec https://dev.twitter.com/docs/auth/pin-based-authorization
Cosmetic function to set the oauth request URLs and api-key and -secret. This only sets the internal value of the parameter if it is non-NIL.
Resets the internal API-KEY, API-SECRET, ACCESS-TOKEN and ACCESS-SECRET to NIL. This does not change the oauth request URLs.
Issue a signed data request against the API.
See SIGNED-REQUEST. The difference to SIGNED-DATA-REQUEST is that
the default PARAMETERS are used to calculate the authorization header,
whereas the DATA-PARAMETERS are not. In SINGED-DATA-REQUEST, neither
of the parameters are used for the header.
Issue a signed data request against the API.
See SIGNED-REQUEST.
According to spec https://dev.twitter.com/docs/uploading-media
Issue a signed request against the API.
This requires the *oauth-api-key*, *oauth-signature-method*,
*oauth-version* and at least *oauth-api-secret* to be set.
See CREATE-SIGNATURE.
For return values see DRAKMA:HTTP-REQUEST
According to spec https://dev.twitter.com/docs/auth/authorizing-request
Issue a signed data request against the API.
See SIGNED-REQUEST. Returns values according to DRAKMA:HTTP-REQUEST with :WANT-STREAM T
Returns a URL-decoded version of the string STRING external format EXTERNAL-FORMAT.
According to spec https://dev.twitter.com/docs/auth/percent-encoding-parameters
Returns a URL-encoded version of the string STRING or OCTET-SEQUENCE using the external format EXTERNAL-FORMAT.
According to spec https://dev.twitter.com/docs/auth/percent-encoding-parameters
oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-parameter-missing)) ¶oauth-parameter-missing)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶oauth-request-error)) ¶error.
:parameter
:status
:body
:headers
:url
:method
:parameters
:sent-headers
The universal to unix time difference in seconds.
Turns the OAuth parameters into the correct header value.
Create an OAuth signature for a request.
This requires at least the *oauth-api-secret* to be bound properly, and
usually the *oauth-access-secret* as well.
According to spec https://dev.twitter.com/docs/auth/creating-signature
Return the unix timestamp for GMT, as required by OAuth.
Returns a base-64 encoded string of the HMAC digest of the given STRING using the KEYSTRING as HMAC key. The encoding of *external-format* is used throughout.
Returns the signed version of the oauth-parameters.
Simply generates a signature and appends the proper parameter.
Turn an oauth-response into an ALIST.
Parses a string boolean. If the string is one of (T, true, 1), then T is returned, otherwise NIL. The check is case-insensitive.
Turns a key into a keyword.
Replaces _ with - and uppercases the string, then interns it
into the keyword package. This is useful to parse the request
responses into an alist.
| Jump to: | (
A C F G H I M O P R S T U W |
|---|
| Jump to: | (
A C F G H I M O P R S T U W |
|---|
| Jump to: | %
*
+
C S |
|---|
| Jump to: | %
*
+
C S |
|---|
| Jump to: | C F O P S T |
|---|
| Jump to: | C F O P S T |
|---|