Auth_OpenID_Association Klassenreferenz

Öffentliche Methoden
	fromExpiresIn ($expires_in, $handle, $secret, $assoc_type)
	Auth_OpenID_Association ($handle, $secret, $issued, $lifetime, $assoc_type)
	getExpiresIn ($now=null)
	equal ($other)
	serialize ()
	deserialize ($class_name, $assoc_s)
	sign ($pairs)
	signMessage ($message)
	_makePairs (&$message)
	getMessageSignature (&$message)
	checkMessageSignature (&$message)
Datenfelder
	$SIG_LENGTH = 20
	$assoc_keys
	$_macs

---

Ausführliche Beschreibung

Definiert in Zeile 44 der Datei Association.php.

---

Dokumentation der Elementfunktionen

_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.

private

Definiert in Zeile 330 der Datei Association.php.

    {
        $signed = $message->getArg(Auth_OpenID_OPENID_NS, 'signed');
        if (!$signed || Auth_OpenID::isFailure($signed)) {
            // raise ValueError('Message has no signed list: %s' % (message,))
            return null;
        }

        $signed_list = explode(',', $signed);
        $pairs = array();
        $data = $message->toPostArgs();
        foreach ($signed_list as $field) {
            $pairs[] = array($field, Auth_OpenID::arrayGet($data,
                                                           'openid.' .
                                                           $field, ''));
        }
        return $pairs;
    }

Auth_OpenID_Association	(	$	handle,
		$	secret,
		$	issued,
		$	lifetime,
		$	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.

private

Parameter:

	string	$handle This is the handle the server gave this association.
	string	$secret This is the shared secret the server generated for this association.
	integer	$issued This is the time this association was issued, in seconds since 00:00 GMT, January 1, 1970. (ie, a unix timestamp)
	integer	$lifetime This is the amount of time this association is good for, measured in seconds since the association was issued.
	string	$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.

Definiert in Zeile 131 der Datei Association.php.

    {
        if (!in_array($assoc_type,
                      Auth_OpenID_getSupportedAssociationTypes())) {
            $fmt = 'Unsupported association type (%s)';
            trigger_error(sprintf($fmt, $assoc_type), E_USER_ERROR);
        }

        $this->handle = $handle;
        $this->secret = $secret;
        $this->issued = $issued;
        $this->lifetime = $lifetime;
        $this->assoc_type = $assoc_type;
    }

checkMessageSignature

(

&$

message

)

Confirm that the signature of these fields matches the signature contained in the data.

private

Definiert in Zeile 367 der Datei Association.php.

    {
        $sig = $message->getArg(Auth_OpenID_OPENID_NS,
                                'sig');

        if (!$sig || Auth_OpenID::isFailure($sig)) {
            return false;
        }

        $calculated_sig = $this->getMessageSignature($message);
        return $calculated_sig == $sig;
    }

deserialize	(	$	class_name,
		$	assoc_s
	)

Parse an association as stored by serialize(). This is the inverse of serialize.

Parameter:

string

$assoc_s Association as serialized by serialize()

Rückgabe:

Auth_OpenID_Association $result instance of this class

Definiert in Zeile 209 der Datei Association.php.

    {
        $pairs = Auth_OpenID_KVForm::toArray($assoc_s, $strict = true);
        $keys = array();
        $values = array();
        foreach ($pairs as $key => $value) {
            if (is_array($value)) {
                list($key, $value) = $value;
            }
            $keys[] = $key;
            $values[] = $value;
        }

        $class_vars = get_class_vars($class_name);
        $class_assoc_keys = $class_vars['assoc_keys'];

        sort($keys);
        sort($class_assoc_keys);

        if ($keys != $class_assoc_keys) {
            trigger_error('Unexpected key values: ' . var_export($keys, true),
                          E_USER_WARNING);
            return null;
        }

        $version = $pairs['version'];
        $handle = $pairs['handle'];
        $secret = $pairs['secret'];
        $issued = $pairs['issued'];
        $lifetime = $pairs['lifetime'];
        $assoc_type = $pairs['assoc_type'];

        if ($version != '2') {
            trigger_error('Unknown version: ' . $version, E_USER_WARNING);
            return null;
        }

        $issued = intval($issued);
        $lifetime = intval($lifetime);
        $secret = base64_decode($secret);

        return new $class_name(
            $handle, $secret, $issued, $lifetime, $assoc_type);
    }

equal

(

$

other

)

This checks to see if two Auth_OpenID_Association instances represent the same association.

Rückgabe:

bool $result true if the two instances represent the same association, false otherwise.

Definiert in Zeile 170 der Datei Association.php.

    {
        return ((gettype($this) == gettype($other))
                && ($this->handle == $other->handle)
                && ($this->secret == $other->secret)
                && ($this->issued == $other->issued)
                && ($this->lifetime == $other->lifetime)
                && ($this->assoc_type == $other->assoc_type));
    }

fromExpiresIn	(	$	expires_in,
		$	handle,
		$	secret,
		$	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.

private

Parameter:

	integer	$expires_in This is the amount of time this association is good for, measured in seconds since the association was issued.
	string	$handle This is the handle the server gave this association.
	string	secret This is the shared secret the server generated for this association.
	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.

Rückgabe:

association An Auth_OpenID_Association instance.

Definiert in Zeile 97 der Datei Association.php.

    {
        $issued = time();
        $lifetime = $expires_in;
        return new Auth_OpenID_Association($handle, $secret,
                                           $issued, $lifetime, $assoc_type);
    }

getExpiresIn

(

$

now = null

)

This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid.

Rückgabe:

integer $seconds The number of seconds this association is still valid for, or 0 if the association is no longer valid.

Definiert in Zeile 154 der Datei Association.php.

    {
        if ($now == null) {
            $now = time();
        }

        return max(0, $this->issued + $this->lifetime - $now);
    }

getMessageSignature

(

&$

message

)

Given an Auth_OpenID_Message, return the signature for the signed list in the message.

private

Definiert in Zeile 355 der Datei Association.php.

    {
        $pairs = $this->_makePairs($message);
        return base64_encode($this->sign($pairs));
    }

serialize

(

)

Convert an association to KV form.

Rückgabe:

string $result String in KV form suitable for deserialization by deserialize.

Definiert in Zeile 186 der Datei Association.php.

    {
        $data = array(
                     'version' => '2',
                     'handle' => $this->handle,
                     'secret' => base64_encode($this->secret),
                     'issued' => strval(intval($this->issued)),
                     'lifetime' => strval(intval($this->lifetime)),
                     'assoc_type' => $this->assoc_type
                     );

        assert(array_keys($data) == $this->assoc_keys);

        return Auth_OpenID_KVForm::fromArray($data, $strict = true);
    }

sign

(

$

pairs

)

Generate a signature for a sequence of (key, value) pairs

private

Parameter:

array

$pairs The pairs to sign, in order. This is an array of two-tuples.

Rückgabe:

string $signature The binary signature of this sequence of pairs

Definiert in Zeile 263 der Datei Association.php.

    {
        $kv = Auth_OpenID_KVForm::fromArray($pairs);

        /* Invalid association types should be caught at constructor */
        $callback = $this->_macs[$this->assoc_type];

        return call_user_func_array($callback, array($this->secret, $kv));
    }

signMessage

(

$

message

)

Generate a signature for some fields in a dictionary

private

Parameter:

	array	$fields The fields to sign, in order; this is an array of strings.
	array	$data Dictionary of values to sign (an array of string => string pairs).

Rückgabe:

string $signature The signature, base64 encoded

Definiert in Zeile 283 der Datei Association.php.

    {
        if ($message->hasKey(Auth_OpenID_OPENID_NS, 'sig') ||
            $message->hasKey(Auth_OpenID_OPENID_NS, 'signed')) {
            // Already has a sig
            return null;
        }

        $extant_handle = $message->getArg(Auth_OpenID_OPENID_NS,
                                          'assoc_handle');

        if ($extant_handle && ($extant_handle != $this->handle)) {
            // raise ValueError("Message has a different association handle")
            return null;
        }

        $signed_message = $message;
        $signed_message->setArg(Auth_OpenID_OPENID_NS, 'assoc_handle',
                                $this->handle);

        $message_keys = array_keys($signed_message->toPostArgs());
        $signed_list = array();
        $signed_prefix = 'openid.';

        foreach ($message_keys as $k) {
            if (strpos($k, $signed_prefix) === 0) {
                $signed_list[] = substr($k, strlen($signed_prefix));
            }
        }

        $signed_list[] = 'signed';
        sort($signed_list);

        $signed_message->setArg(Auth_OpenID_OPENID_NS, 'signed',
                                implode(',', $signed_list));
        $sig = $this->getMessageSignature($signed_message);
        $signed_message->setArg(Auth_OpenID_OPENID_NS, 'sig', $sig);
        return $signed_message;
    }

---

Dokumentation der Datenelemente

$_macs

Initialisierung:

 array(
                       'HMAC-SHA1' => 'Auth_OpenID_HMACSHA1',
                       'HMAC-SHA256' => 'Auth_OpenID_HMACSHA256'
                       )

Definiert in Zeile 67 der Datei Association.php.

$assoc_keys

Initialisierung:

 array(
                            'version',
                            'handle',
                            'secret',
                            'issued',
                            'lifetime',
                            'assoc_type'
                            )

The ordering and name of keys as stored by serialize.

private

Definiert in Zeile 58 der Datei Association.php.

$SIG_LENGTH = 20

This is a HMAC-SHA1 specific value.

private

Definiert in Zeile 51 der Datei Association.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Auth/OpenID/Association.php