class (none) \ BasicProvider



Method Summary

Name Description
__construct()
checkid($realm, $attributes) Checks whether an user is authenticated. The function should determine what fields it wants to send to the RP, and put them in the $attributes array.
setup($identity, $realm, $assoc_handle, $attributes) Displays an user interface for inputting user's login and password. Attributes are always AX field namespaces, with stripped host part. For example, the $attributes array may be: array( 'required' => array('namePerson/friendly', 'contact/email'), 'optional' => array('pref/timezone', 'pref/language')

Inherited Method Summary

Name Description
__call($name, $args) (from LightOpenIDProvider)
assoc_handle() Generates a new association handle. (from LightOpenIDProvider)
associate() Performs association with an RP. (from LightOpenIDProvider)
ax() (from LightOpenIDProvider)
b64dec($str) Converts base64 encoded number to it's decimal representation. (from LightOpenIDProvider)
cancel() Responds with an information that the user has canceled authentication. (from LightOpenIDProvider)
checkRealm() (from LightOpenIDProvider)
decb64($num) Complements b64dec. (from LightOpenIDProvider)
delAssoc($handle) Deletes an association. If you want to use php sessions in your provider code, you have to replace it. (from LightOpenIDProvider)
dh() Encrypts the MAC key using DH key exchange. (from LightOpenIDProvider)
errorResponse() Outputs a direct error. (from LightOpenIDProvider)
generateAssociation() Creates a private association. (from LightOpenIDProvider)
getAssoc($handle) Retreives association data. If you want to use php sessions in your provider code, you have to replace it. (from LightOpenIDProvider)
keyValueForm($params) Encodes fields in key-value form. (from LightOpenIDProvider)
keygen($length) Generates a private key. (from LightOpenIDProvider)
positiveResponse($identity, $attributes) Sends an positive assertion. (from LightOpenIDProvider)
redirect($location) Redirects the user to an url. (from LightOpenIDProvider)
response($params) Prepares an indirect response url. (from LightOpenIDProvider)
responseAttributes($attributes) Prepares an array of attributes to send (from LightOpenIDProvider)
server() Does everything that a provider has to -- in one function. (from LightOpenIDProvider)
setAssoc($handle, $assoc) Stores an association. If you want to use php sessions in your provider code, you have to replace it. (from LightOpenIDProvider)
shared_secret($hash) Generates a random shared secret. (from LightOpenIDProvider)
sreg() (from LightOpenIDProvider)
verify() Aids an RP in assertion verification. (from LightOpenIDProvider)
x_or($a, $b) XORs two strings. (from LightOpenIDProvider)
xrds($force = null) Displays an XRDS document, or redirects to it. By default, it detects whether it should display or redirect automatically. (from LightOpenIDProvider)
xrdsContent() Returns the content of the XRDS document (from LightOpenIDProvider)

public function __construct()

Overrides:
__construct()

public function checkid($realm, $attributes)

Checks whether an user is authenticated. The function should determine what fields it wants to send to the RP, and put them in the $attributes array. (from checkid)

Overrides:
checkid($realm, $attributes)
Parameters:
Array - $attributes
String - $realm Realm used for authentication.
Returns:
String OP-local identifier of an authenticated user, or an empty value.

public function setup($identity, $realm, $assoc_handle, $attributes)

Displays an user interface for inputting user's login and password. Attributes are always AX field namespaces, with stripped host part. For example, the $attributes array may be: array( 'required' => array('namePerson/friendly', 'contact/email'), 'optional' => array('pref/timezone', 'pref/language') (from setup)

Overrides:
setup($identity, $realm, $assoc_handle, $attributes)
Parameters:
String - Association handle. must be sent as openid.assoc_handle in $_GET or $_POST in subsequent requests.
Array - User attributes requested by the RP.