Auth_OpenID_Server Class Reference

Detailed Description

I handle requests for an OpenID server.

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

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

All my state is encapsulated in an Auth_OpenID_OpenIDStore.

Example:

 $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);

Definition at line 1676 of file Server.php.


Public Member Functions
	Auth_OpenID_Server (&$store, $op_endpoint=null)
	handleRequest ($request)
	openid_check_authentication (&$request)
	openid_associate (&$request)
	encodeResponse (&$response)
	decodeRequest ($query=null)

Member Function Documentation

Auth_OpenID_Server.Auth_OpenID_Server	(	&$	store,
		$	op_endpoint = `null`
	)

Definition at line 1677 of file Server.php.

Auth_OpenID_Server.handleRequest ( $ request )

Handle a request. Given an Auth_OpenID_Request object, call the appropriate Auth_OpenID_Server method to process the request and generate a response.

Parameters:

Auth_OpenID_Request

$request An Auth_OpenID_Request returned by Auth_OpenID_Server::decodeRequest().

Returns:: Auth_OpenID_ServerResponse $response A response object capable of generating a user-agent reply.

Definition at line 1698 of file Server.php.

Auth_OpenID_Server.openid_check_authentication ( &$ request )

The callback for 'check_authentication' messages.

Definition at line 1710 of file Server.php.

Auth_OpenID_Server.openid_associate ( &$ request )

The callback for 'associate' messages.

Definition at line 1718 of file Server.php.

Auth_OpenID_Server.encodeResponse ( &$ response )

Encodes as response in the appropriate format suitable for sending to the user agent.

Definition at line 1741 of file Server.php.

Auth_OpenID_Server.decodeRequest ( $ query = null )

Decodes a query args array into the appropriate Auth_OpenID_Request object.

Definition at line 1750 of file Server.php.

The documentation for this class was generated from the following file:

core/openid/Auth/OpenID/Server.php

Auth_OpenID_Server Class Reference

Detailed Description

Public Member Functions

Member Function Documentation