Class Auth_OpenID_Association

This class represents an association between a server and a consumer. In general, users of this library will never see instances of this object. The only exception is if you implement a custom Auth_OpenID_OpenIDStore.

If you do implement such a store, it will need to store the values of the handle, secret, issued, lifetime, and assoc_type instance variables.

Package: OpenID
Copyright: 2005-2008 Janrain, Inc.
License: Apache
Author: JanRain, Inc. openid@janrain.com
Located at zp-extensions/federated_logon/Auth/OpenID/Association.php

Methods summary
`public static association`	# `fromExpiresIn( integer $expires_in, string $handle, string $secret, assoc_type $assoc_type )` This is an alternate constructor (factory method) used by the OpenID consumer library to create associations. OpenID store implementations shouldn't use this constructor. This is an alternate constructor (factory method) used by the OpenID consumer library to create associations. OpenID store implementations shouldn't use this constructor. Parameters `$expires_in` This is the amount of time this association is good for, measured in seconds since the association was issued. `$handle` This is the handle the server gave this association. `$secret` This is the shared secret the server generated for this association. `$assoc_type` is the type of association this instance represents. The only valid values of this field at this time is 'HMAC-SHA1' and 'HMAC-SHA256', but new types may be defined in the future. Returns association An `Auth_OpenID_Association` instance.
`public`	# `Auth_OpenID_Association( string $handle, string $secret, integer $issued, integer $lifetime, string $assoc_type )` This is the standard constructor for creating an association. The library should create all of the necessary associations, so this constructor is not part of the external API. This is the standard constructor for creating an association. The library should create all of the necessary associations, so this constructor is not part of the external API. Parameters `$handle` This is the handle the server gave this association. `$secret` This is the shared secret the server generated for this association. `$issued` This is the time this association was issued, in seconds since 00:00 GMT, January 1, 1970. (ie, a unix timestamp) `$lifetime` This is the amount of time this association is good for, measured in seconds since the association was issued. `$assoc_type` This is the type of association this instance represents. The only valid values of this field at this time is 'HMAC-SHA1' and 'HMAC-SHA256', but new types may be defined in the future.
`public integer`	# `getExpiresIn( $now = null )` This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid. This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid. Returns integer $seconds The number of seconds this association is still valid for, or 0 if the association is no longer valid.
`public boolean`	# `equal( $other )` This checks to see if two `Auth_OpenID_Association` instances represent the same association. This checks to see if two `Auth_OpenID_Association` instances represent the same association. Returns boolean $result true if the two instances represent the same association, false otherwise.
`public string`	# `serialize( )` Convert an association to KV form. Convert an association to KV form. Returns string $result String in KV form suitable for deserialization by deserialize.
`public static Auth_OpenID_Association`	# `deserialize( string $class_name, $assoc_s )` Parse an association as stored by serialize(). This is the inverse of serialize. Parse an association as stored by serialize(). This is the inverse of serialize. Parameters `$class_name` $assoc_s Association as serialized by serialize() `$assoc_s` Returns `Auth_OpenID_Association` $result instance of this class
`public string`	# `sign( array $pairs )` Generate a signature for a sequence of (key, value) pairs Generate a signature for a sequence of (key, value) pairs Parameters `$pairs` The pairs to sign, in order. This is an array of two-tuples. Returns string $signature The binary signature of this sequence of pairs
`public string`	# `signMessage( array $message, array $data,… )` Generate a signature for some fields in a dictionary Generate a signature for some fields in a dictionary Parameters `$message` $fields The fields to sign, in order; this is an array of strings. `$data`,… Dictionary of values to sign (an array of string => string pairs). Returns string $signature The signature, base64 encoded
`public`	# `_makePairs( $message )` Given a `Auth_OpenID_Message`, return the key/value pairs to be signed according to the signed list in the message. If the message lacks a signed list, return null. Given a `Auth_OpenID_Message`, return the key/value pairs to be signed according to the signed list in the message. If the message lacks a signed list, return null.
`public`	# `getMessageSignature( $message )` Given an `Auth_OpenID_Message`, return the signature for the signed list in the message. Given an `Auth_OpenID_Message`, return the signature for the signed list in the message.
`public`	# `checkMessageSignature( $message )` Confirm that the signature of these fields matches the signature contained in the data. Confirm that the signature of these fields matches the signature contained in the data.

Properties summary
`public integer`	`$SIG_LENGTH` This is a HMAC-SHA1 specific value. This is a HMAC-SHA1 specific value.	# `20`
`public array`	`$assoc_keys` The ordering and name of keys as stored by serialize. The ordering and name of keys as stored by serialize.	# `array( 'version', 'handle', 'secret', 'issued', 'lifetime', 'assoc_type' )`
`public array`	`$_macs`	# `array( 'HMAC-SHA1' => 'Auth_OpenID_HMACSHA1', 'HMAC-SHA256' => 'Auth_OpenID_HMACSHA256' )`

Packages

Classes

Functions

Class Auth_OpenID_Association

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns