Auth_OpenID_SessionNegotiator Class Reference

List of all members.

---

Detailed Description

A session negotiator controls the allowed and preferred association types and association session types. Both the Auth_OpenID_Consumer and Auth_OpenID_Server use negotiators when creating associations.

You can create and use negotiators if you:

• Do not want to do Diffie-Hellman key exchange because you use transport-layer encryption (e.g. SSL)

• Want to use only SHA-256 associations

• Do not want to support plain-text associations over a non-secure channel

It is up to you to set a policy for what kinds of associations to accept. By default, the library will make any kind of association that is allowed in the OpenID 2.0 specification.

Use of negotiators in the library =================================

When a consumer makes an association request, it calls getAllowedType to get the preferred association type and association session type.

The server gets a request for a particular association/session type and calls isAllowed to determine if it should create an association. If it is supported, negotiation is complete. If it is not, the server calls getAllowedType to get an allowed association type to return to the consumer.

If the consumer gets an error response indicating that the requested association/session type is not supported by the server that contains an assocation/session type to try, it calls isAllowed to determine if it should try again with the given combination of association/session type.

Definition at line 527 of file Association.php.

Public Member Functions
	Auth_OpenID_SessionNegotiator ($allowed_types)
	setAllowedTypes ($allowed_types)
	addAllowedType ($assoc_type, $session_type=null)
	isAllowed ($assoc_type, $session_type)
	getAllowedType ()

---

Member Function Documentation

Auth_OpenID_SessionNegotiator.Auth_OpenID_SessionNegotiator

(

$

allowed_types

)

Definition at line 528 of file Association.php.

Auth_OpenID_SessionNegotiator.setAllowedTypes

(

$

allowed_types

)

Set the allowed association types, checking to make sure each combination is valid.

private

Definition at line 540 of file Association.php.

Auth_OpenID_SessionNegotiator.addAllowedType	(	$	assoc_type,
		$	session_type = null
	)

Add an association type and session type to the allowed types list. The assocation/session pairs are tried in the order that they are added.

private

Definition at line 560 of file Association.php.

Auth_OpenID_SessionNegotiator.isAllowed	(	$	assoc_type,
		$	session_type
	)

Definition at line 588 of file Association.php.

Auth_OpenID_SessionNegotiator.getAllowedType

(

)

Get a pair of assocation type and session type that are supported.

Definition at line 603 of file Association.php.

---

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

• core/openid/Auth/OpenID/Association.php