- Publicity: Public Only All
oauth-procs.tcl
XOTcl OAuth Library for OpenACS This library strives to provide a comprehensive implementation of the OAuth 1.0a protocol (RFC 5849) for OpenACS. Currently, it supports signed requests using HMAC-SHA1.
This file defines the following Objects and Classes: ::xo::oauth::ServerMetadata, ::xo::oauth::ClientMetadata, ::xo::oauth::Credentials, ::xo::oauth::TempCredentials, ::xo::oauth::TokenCredentials, ::xo::oauth::Signature
- Location:
- packages/xooauth/tcl/oauth-procs.tcl
- Created:
- 2012-01 This work has been partly influenced by: * Guan Yang - guan@unicast.org * https://github.com/horgh/twitter-tcl Translation to XOTcl2: Gustaf Neumann
- Author:
- Michael Aram
Procedures in this file
- Class ::xo::oauth::ClientMetadata (public)
- Class ::xo::oauth::Credentials (public)
- Class ::xo::oauth::ServerMetadata (public)
- Class ::xo::oauth::Signature (public)
- Class ::xo::oauth::TempCredentials (public)
- Class ::xo::oauth::TokenCredentials (public)
- xo::oauth::Signature instproc encode (public)
- xo::oauth::Signature proc base_string_from_url (public)
- xo::oauth::nonce (public)
- xo::oauth::timestamp (public)
Detailed information
Class ::xo::oauth::ClientMetadata (public)
::xo::db::CrClass ::xo::oauth::ClientMetadata
Client Metadata is typically stored at the server side.
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xo::oauth::Credentials (public)
::xo::db::CrClass ::xo::oauth::Credentials
All credentials are unique only between a client-server pair, which is the reason to store the client and server id at this level.
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xo::oauth::ServerMetadata (public)
::xo::db::CrClass ::xo::oauth::ServerMetadata
Server Metadata is typically stored at the client side
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xo::oauth::Signature (public)
::xotcl::Class ::xo::oauth::Signature \ [ -protocol_parameters protocol_parameters ]
- Switches:
- -protocol_parameters
(optional)- Expects a list of key-value pairs representing parameters of different sources.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xo::oauth::TempCredentials (public)
::xo::db::CrClass ::xo::oauth::TempCredentials
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xo::oauth::TokenCredentials (public)
::xo::db::CrClass ::xo::oauth::TokenCredentials
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xo::oauth::Signature instproc encode (public)
<instance of xo::oauth::Signature> encode s
- Parameters:
- s
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xo::oauth::Signature proc base_string_from_url (public)
xo::oauth::Signature base_string_from_url uri
This procedure transforms a given URL into a format that is conformant to "http://tools.ietf.org/html/rfc5849#section-3.4.1.2". Most importantly, it strips any query part from the URL.
- Parameters:
- uri
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xo::oauth::nonce (public)
xo::oauth::nonce
- Returns:
- a nonce for the current request.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xo::oauth::timestamp (public)
xo::oauth::timestamp
- Returns:
- the current epoch timestamp in seconds
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.