Auth_OpenID_PAPE_Response Klassenreferenz

Abgeleitet von Auth_OpenID_Extension.

Zusammengehörigkeiten von Auth_OpenID_PAPE_Response:

[Legende]

Öffentliche Methoden
	Auth_OpenID_PAPE_Response ($auth_policies=null, $auth_time=null, $nist_auth_level=null)
	addPolicyURI ($policy_uri)
	fromSuccessResponse ($success_response)
	parseExtensionArgs ($args, $strict=false)
	getExtensionArgs ()
Datenfelder
	$ns_alias = 'pape'
	$ns_uri = Auth_OpenID_PAPE_NS_URI

---

Ausführliche Beschreibung

A Provider Authentication Policy response, sent from a provider to a relying party

Definiert in Zeile 154 der Datei PAPE.php.

---

Dokumentation der Elementfunktionen

addPolicyURI

(

$

policy_uri

)

Add a authentication policy to this response

This method is intended to be used by the provider to add a policy that the provider conformed to when authenticating the user.

Parameter:

policy_uri,:

The identifier for the preferred type of authentication.

Definiert in Zeile 182 der Datei PAPE.php.

                        : The identifier for the preferred type of
     * authentication.
     */
    function addPolicyURI($policy_uri)

Auth_OpenID_PAPE_Response	(	$	auth_policies = null,
		$	auth_time = null,
		$	nist_auth_level = null
	)

Definiert in Zeile 159 der Datei PAPE.php.

                                                              {

    var $ns_alias = 'pape';
    var $ns_uri = Auth_OpenID_PAPE_NS_URI;

    function Auth_OpenID_PAPE_Response($auth_policies=null, $auth_time=null,
                                       $nist_auth_level=null)
    {
        if ($auth_policies) {
            $this->auth_policies = $auth_policies;
        } else {
            $this->auth_policies = array();

fromSuccessResponse

(

$

success_response

)

Create an Auth_OpenID_PAPE_Response object from a successful OpenID library response.

Parameter:

success_response

$success_response A SuccessResponse from Auth_OpenID_Consumer::complete()

Rückgabe:

: A provider authentication policy response from the data that was supplied with the id_res response.

Definiert in Zeile 199 der Datei PAPE.php.

               : A provider authentication policy response from the
     * data that was supplied with the id_res response.
     */
    function fromSuccessResponse($success_response)
    {
        $obj = new Auth_OpenID_PAPE_Response();

        // PAPE requires that the args be signed.
        $args = $success_response->getSignedNS(Auth_OpenID_PAPE_NS_URI);

        if ($args === null || $args === array()) {
            return null;
        }

        $result = $obj->parseExtensionArgs($args);

        if ($result === false) {

getExtensionArgs

(

)

Get the string arguments that should be added to an OpenID message for this extension.

Erneute Implementation von Auth_OpenID_Extension.

Definiert in Zeile 268 der Datei PAPE.php.

    {
        $ns_args = array();
        if (count($this->auth_policies) > 0) {
            $ns_args['auth_policies'] = implode(' ', $this->auth_policies);
        } else {
            $ns_args['auth_policies'] = 'none';
        }

        if ($this->nist_auth_level !== null) {
            if (!in_array($this->nist_auth_level, range(0, 4), true)) {
                return false;
            }
            $ns_args['nist_auth_level'] = strval($this->nist_auth_level);
        }

        if ($this->auth_time !== null) {
            if (!ereg(PAPE_TIME_VALIDATOR, $this->auth_time)) {
                return false;
            }

parseExtensionArgs	(	$	args,
		$	strict = false
	)

Parse the provider authentication policy arguments into the internal state of this object

Parameter:

	args,:	unqualified provider authentication policy arguments
	strict,:	Whether to return false when bad data is encountered

Rückgabe:

null The data is parsed into the internal fields of this object.

Definiert in Zeile 232 der Datei PAPE.php.

    {
        $policies_str = Auth_OpenID::arrayGet($args, 'auth_policies');
        if ($policies_str && $policies_str != "none") {
            $this->auth_policies = explode(" ", $policies_str);
        }

        $nist_level_str = Auth_OpenID::arrayGet($args, 'nist_auth_level');
        if ($nist_level_str !== null) {
            $nist_level = Auth_OpenID::intval($nist_level_str);

            if ($nist_level === false) {
                if ($strict) {
                    return false;
                } else {
                    $nist_level = null;
                }
            }

            if (0 <= $nist_level && $nist_level < 5) {
                $this->nist_auth_level = $nist_level;
            } else if ($strict) {
                return false;
            }
        }

        $auth_time = Auth_OpenID::arrayGet($args, 'auth_time');
        if ($auth_time !== null) {
            if (ereg(PAPE_TIME_VALIDATOR, $auth_time)) {
                $this->auth_time = $auth_time;

---

Dokumentation der Datenelemente

$ns_alias = 'pape'

Erneute Implementation von Auth_OpenID_Extension.

Definiert in Zeile 156 der Datei PAPE.php.

$ns_uri = Auth_OpenID_PAPE_NS_URI

ns_uri: The namespace to which to add the arguments for this extension

Erneute Implementation von Auth_OpenID_Extension.

Definiert in Zeile 157 der Datei PAPE.php.

---

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

• Auth/OpenID/PAPE.php