[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/openid/Auth/OpenID/ -> Server.php (summary)

[Source view] [Print] [Project Stats]

OpenID server protocol and logic. Overview

Author: JanRain, Inc. <openid@janrain.com>
Copyright: 2005-2008 Janrain, Inc.
License: http://www.apache.org/licenses/LICENSE-2.0 Apache
File Size: 1763 lines (57 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 21 classes

Auth_OpenID_ServerError:: (10 methods):
  Auth_OpenID_ServerError()
  getReturnTo()
  hasReturnTo()
  encodeToURL()
  encodeToKVForm()
  toFormMarkup()
  toHTML()
  toMessage()
  whichEncoding()
  toString()

Auth_OpenID_NoReturnToError:: (2 methods):
  Auth_OpenID_NoReturnToError()
  toString()

Auth_OpenID_MalformedReturnURL:: (1 method):
  Auth_OpenID_MalformedReturnURL()

Auth_OpenID_MalformedTrustRoot:: (2 methods):
  Auth_OpenID_MalformedTrustRoot()
  toString()

Auth_OpenID_Request:: (0 methods):

Auth_OpenID_CheckAuthRequest:: (3 methods):
  Auth_OpenID_CheckAuthRequest()
  fromMessage()
  answer()

Auth_OpenID_PlainTextServerSession:: (2 methods):
  fromMessage()
  answer()

Auth_OpenID_DiffieHellmanSHA1ServerSession:: (4 methods):
  Auth_OpenID_DiffieHellmanSHA1ServerSession()
  getDH()
  fromMessage()
  answer()

Auth_OpenID_DiffieHellmanSHA256ServerSession:: (1 method):
  fromMessage()

Auth_OpenID_AssociateRequest:: (5 methods):
  getSessionClasses()
  Auth_OpenID_AssociateRequest()
  fromMessage()
  answer()
  answerUnsupported()

Auth_OpenID_CheckIDRequest:: (10 methods):
  make()
  Auth_OpenID_CheckIDRequest()
  equals()
  returnToVerified()
  fromMessage()
  idSelect()
  trustRootValid()
  answer()
  encodeToURL()
  getCancelURL()

Auth_OpenID_ServerResponse:: (9 methods):
  Auth_OpenID_ServerResponse()
  whichEncoding()
  toFormMarkup()
  toHTML()
  renderAsForm()
  encodeToURL()
  addExtension()
  needsSigning()
  encodeToKVForm()

Auth_OpenID_WebResponse:: (1 method):
  Auth_OpenID_WebResponse()

Auth_OpenID_Signatory:: (6 methods):
  Auth_OpenID_Signatory()
  verify()
  sign()
  createAssociation()
  getAssociation()
  invalidate()

Auth_OpenID_Encoder:: (1 method):
  encode()

Auth_OpenID_SigningEncoder:: (2 methods):
  Auth_OpenID_SigningEncoder()
  encode()

Auth_OpenID_Decoder:: (3 methods):
  Auth_OpenID_Decoder()
  decode()
  defaultDecoder()

Auth_OpenID_EncodingError:: (1 method):
  Auth_OpenID_EncodingError()

Auth_OpenID_AlreadySigned:: (0 methods):

Auth_OpenID_UntrustedReturnURL:: (2 methods):
  Auth_OpenID_UntrustedReturnURL()
  toString()

Auth_OpenID_Server:: (6 methods):
  Auth_OpenID_Server()
  handleRequest()
  openid_check_authentication()
  openid_associate()
  encodeResponse()
  decodeRequest()

Defines 6 functions

  Auth_OpenID_isError()

Class: Auth_OpenID_ServerError  - X-Ref

An error class which gets instantiated and returned whenever an
OpenID protocol error occurs.  Be prepared to use this in place of
an ordinary server response.

Auth_OpenID_ServerError($message = null, $text = null,$reference = null, $contact = null)   X-Ref


getReturnTo()   X-Ref
No description

hasReturnTo()   X-Ref
Returns the return_to URL for the request which caused this
error.


encodeToURL()   X-Ref
Encodes this error's response as a URL suitable for
redirection.  If the response has no return_to, another
Auth_OpenID_ServerError is returned.


encodeToKVForm()   X-Ref
Encodes the response to key-value form.  This is a
machine-readable format used to respond to messages which came
directly from the consumer and not through the user-agent.  See
the OpenID specification.


toFormMarkup($form_tag_attrs=null)   X-Ref
No description

toHTML($form_tag_attrs=null)   X-Ref
No description

toMessage()   X-Ref
No description

whichEncoding()   X-Ref
Returns one of Auth_OpenID_ENCODE_URL,
Auth_OpenID_ENCODE_KVFORM, or null, depending on the type of
encoding expected for this error's payload.


toString()   X-Ref
Returns this error message.


Class: Auth_OpenID_NoReturnToError  - X-Ref

Error returned by the server code when a return_to is absent from a
request.

Auth_OpenID_NoReturnToError($message = null,$text = "No return_to URL available")   X-Ref
No description

toString()   X-Ref
No description

Class: Auth_OpenID_MalformedReturnURL  - X-Ref

An error indicating that the return_to URL is malformed.

Auth_OpenID_MalformedReturnURL($message, $return_to)   X-Ref
No description

Class: Auth_OpenID_MalformedTrustRoot  - X-Ref

This error is returned when the trust_root value is malformed.

Auth_OpenID_MalformedTrustRoot($message = null,$text = "Malformed trust root")   X-Ref
No description

toString()   X-Ref
No description

Class: Auth_OpenID_Request  - X-Ref

The base class for all server request classes.

Class: Auth_OpenID_CheckAuthRequest  - X-Ref

A request to verify the validity of a previous response.

Auth_OpenID_CheckAuthRequest($assoc_handle, $signed,$invalidate_handle = null)   X-Ref
No description

fromMessage($message, $server=null)   X-Ref
No description

answer(&$signatory)   X-Ref
No description

Class: Auth_OpenID_PlainTextServerSession  - X-Ref

A class implementing plaintext server sessions.

fromMessage($unused_request)   X-Ref
No description

answer($secret)   X-Ref
No description

Class: Auth_OpenID_DiffieHellmanSHA1ServerSession  - X-Ref

A class implementing DH-SHA1 server sessions.

Auth_OpenID_DiffieHellmanSHA1ServerSession($dh, $consumer_pubkey)   X-Ref
No description

getDH($message)   X-Ref
No description

fromMessage($message)   X-Ref
No description

answer($secret)   X-Ref
No description

Class: Auth_OpenID_DiffieHellmanSHA256ServerSession  - X-Ref

A class implementing DH-SHA256 server sessions.

fromMessage($message)   X-Ref
No description

Class: Auth_OpenID_AssociateRequest  - X-Ref

A request to associate with the server.

getSessionClasses()   X-Ref
No description

Auth_OpenID_AssociateRequest(&$session, $assoc_type)   X-Ref
No description

fromMessage($message, $server=null)   X-Ref
No description

answer($assoc)   X-Ref
No description

answerUnsupported($text_message,$preferred_association_type=null,$preferred_session_type=null)   X-Ref
No description

Class: Auth_OpenID_CheckIDRequest  - X-Ref

A request to confirm the identity of a user.

make(&$message, $identity, $return_to, $trust_root = null,$immediate = false, $assoc_handle = null, $server = null)   X-Ref
The OpenID namespace for this request.
deprecated since version 2.0.2


Auth_OpenID_CheckIDRequest($identity, $return_to,$trust_root = null, $immediate = false,$assoc_handle = null, $server = null,$claimed_id = null)   X-Ref
No description

equals($other)   X-Ref
No description

returnToVerified()   X-Ref
No description

fromMessage(&$message, $server)   X-Ref
No description

idSelect()   X-Ref
No description

trustRootValid()   X-Ref
No description

answer($allow, $server_url = null, $identity = null,$claimed_id = null)   X-Ref
Respond to this request.  Return either an
{@link Auth_OpenID_ServerResponse} or
{@link Auth_OpenID_ServerError}.

param: bool $allow Allow this user to claim this identity, and
param: string $server_url DEPRECATED.  Passing $op_endpoint to
param: string $identity The OP-local identifier to answer with.
param: string $claimed_id The claimed identifier to answer
return: mixed

encodeToURL($server_url)   X-Ref
No description

getCancelURL()   X-Ref
No description

Class: Auth_OpenID_ServerResponse  - X-Ref

This class encapsulates the response to an OpenID server request.

Auth_OpenID_ServerResponse(&$request)   X-Ref
No description

whichEncoding()   X-Ref
No description

toFormMarkup($form_tag_attrs=null)   X-Ref
No description

toHTML()   X-Ref
No description

renderAsForm()   X-Ref
No description

encodeToURL()   X-Ref
No description

addExtension($extension_response)   X-Ref
No description

needsSigning()   X-Ref
No description

encodeToKVForm()   X-Ref
No description

Class: Auth_OpenID_WebResponse  - X-Ref

A web-capable response object which you can use to generate a
user-agent response.

Auth_OpenID_WebResponse($code = null, $headers = null,$body = null)   X-Ref
No description

Class: Auth_OpenID_Signatory  - X-Ref

Responsible for the signature of query data and the verification of
OpenID signature values.

Auth_OpenID_Signatory(&$store)   X-Ref
Create a new signatory using a given store.


verify($assoc_handle, $message)   X-Ref
Verify, using a given association handle, a signature with
signed key-value pairs from an HTTP request.


sign($response)   X-Ref
Given a response, sign the fields in the response's 'signed'
list, and insert the signature into the response.


createAssociation($dumb = true, $assoc_type = 'HMAC-SHA1')   X-Ref
Make a new association.


getAssociation($assoc_handle, $dumb, $check_expiration=true)   X-Ref
Given an association handle, get the association from the
store, or return a ServerError or null if something goes wrong.


invalidate($assoc_handle, $dumb)   X-Ref
Invalidate a given association handle.


Class: Auth_OpenID_Encoder  - X-Ref

Encode an {@link Auth_OpenID_ServerResponse} to an
{@link Auth_OpenID_WebResponse}.

encode(&$response)   X-Ref
Encode an {@link Auth_OpenID_ServerResponse} and return an
{@link Auth_OpenID_WebResponse}.


Class: Auth_OpenID_SigningEncoder  - X-Ref

An encoder which also takes care of signing fields when required.

Auth_OpenID_SigningEncoder(&$signatory)   X-Ref
No description

encode(&$response)   X-Ref
Sign an {@link Auth_OpenID_ServerResponse} and return an
{@link Auth_OpenID_WebResponse}.


Class: Auth_OpenID_Decoder  - X-Ref

Decode an incoming query into an Auth_OpenID_Request.

Auth_OpenID_Decoder(&$server)   X-Ref
No description

decode($query)   X-Ref
Given an HTTP query in an array (key-value pairs), decode it
into an Auth_OpenID_Request object.


defaultDecoder($message)   X-Ref
No description

Class: Auth_OpenID_EncodingError  - X-Ref

An error that indicates an encoding problem occurred.

Auth_OpenID_EncodingError(&$response)   X-Ref
No description

Class: Auth_OpenID_AlreadySigned  - X-Ref

An error that indicates that a response was already signed.

Class: Auth_OpenID_UntrustedReturnURL  - X-Ref

An error that indicates that the given return_to is not under the
given trust_root.

Auth_OpenID_UntrustedReturnURL($message, $return_to,$trust_root)   X-Ref
No description

toString()   X-Ref
No description

Class: Auth_OpenID_Server  - X-Ref

I handle requests for an OpenID server.

Some types of requests (those which are not checkid requests) may
be handed to my {@link handleRequest} method, and I will take care
of it and return a response.

For your convenience, I also provide an interface to {@link
Auth_OpenID_Decoder::decode()} and {@link
Auth_OpenID_SigningEncoder::encode()} through my methods {@link
decodeRequest} and {@link encodeResponse}.

All my state is encapsulated in an {@link Auth_OpenID_OpenIDStore}.

Example:

<pre> $oserver = new Auth_OpenID_Server(Auth_OpenID_FileStore($data_path),
"http://example.com/op");
$request = $oserver->decodeRequest();
if (in_array($request->mode, array('checkid_immediate',
'checkid_setup'))) {
if ($app->isAuthorized($request->identity, $request->trust_root)) {
$response = $request->answer(true);
} else if ($request->immediate) {
$response = $request->answer(false);
} else {
$app->showDecidePage($request);
return;
}
} else {
$response = $oserver->handleRequest($request);
}

$webresponse = $oserver->encode($response);</pre>

Auth_OpenID_Server(&$store, $op_endpoint=null)   X-Ref
No description

handleRequest($request)   X-Ref
Handle a request.  Given an {@link Auth_OpenID_Request} object,
call the appropriate {@link Auth_OpenID_Server} method to
process the request and generate a response.

param: Auth_OpenID_Request $request An {@link Auth_OpenID_Request}
return: Auth_OpenID_ServerResponse $response A response object

openid_check_authentication(&$request)   X-Ref
The callback for 'check_authentication' messages.


openid_associate(&$request)   X-Ref
The callback for 'associate' messages.


encodeResponse(&$response)   X-Ref
Encodes as response in the appropriate format suitable for
sending to the user agent.


decodeRequest($query=null)   X-Ref
Decodes a query args array into the appropriate
{@link Auth_OpenID_Request} object.


Functions
Functions that are not part of a class:

Auth_OpenID_isError($obj, $cls = 'Auth_OpenID_ServerError')   X-Ref



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1