JanRain OpenID Library

Auth_OpenID_SessionNegotiator
in package

A session negotiator controls the allowed and preferred association types and association session types. Both the {@link Auth_OpenID_Consumer} and {@link 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 to get the preferred association type and association session type.

The server gets a request for a particular association/session type and calls to determine if it should create an association. If it is supported, negotiation is complete. If it is not, the server calls 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 to determine if it should try again with the given combination of association/session type.

Table of Contents

__construct()  : mixed
addAllowedType()  : bool
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.
getAllowedType()  : mixed
Get a pair of assocation type and session type that are supported.
isAllowed()  : mixed
setAllowedTypes()  : bool
Set the allowed association types, checking to make sure each combination is valid.

Methods

__construct()

public __construct(mixed $allowed_types) : mixed
Parameters
$allowed_types : mixed
Return values
mixed —

addAllowedType()

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.

public addAllowedType( $assoc_type[, null $session_type = null ]) : bool
Parameters
$assoc_type :
$session_type : null = null
Tags
access

private

Return values
bool —

getAllowedType()

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

public getAllowedType() : mixed
Return values
mixed —

isAllowed()

public isAllowed(mixed $assoc_type, mixed $session_type) : mixed
Parameters
$assoc_type : mixed
$session_type : mixed
Return values
mixed —

setAllowedTypes()

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

public setAllowedTypes(array<string|int, mixed> $allowed_types) : bool
Parameters
$allowed_types : array<string|int, mixed>
Tags
access

private

Return values
bool —

Search results