phpPoA2
[ class tree: phpPoA2 ] [ index: phpPoA2 ] [ all elements ]

Procedural File: PAPIAuthnEngine.php

Source Location: /lib/authn/PAPIAuthnEngine.php



Classes:

PAPIAuthnEngine
Authentication engine for the PAPI 1.5 protocol.


Page Details:



Tags:

author:  Jaime Perez <jaime.perez@rediris.es>
version:  2.0
copyright:  

Copyright 2005-2010 RedIRIS, http://www.rediris.es/

This file is part of phpPoA2.

phpPoA2 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

phpPoA2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with phpPoA2. If not, see <http://www.gnu.org/licenses/>.

filesource:  Source Code for this file
license:  GNU General Public License







ATTR_SEPARATOR [line 29]

ATTR_SEPARATOR = ","
Default assertion delimiters for standard PAPI 1.5 protocol.


[ Top ]



NAMEVALUE_SEPARATOR [line 31]

NAMEVALUE_SEPARATOR = "="

[ Top ]



NS_PAPI_ATTRIBUTES [line 44]

NS_PAPI_ATTRIBUTES = 'urn:mace:rediris.es:papi:attributes'

[ Top ]



NS_PAPI_PROTOCOL [line 43]

NS_PAPI_PROTOCOL = 'urn:mace:rediris.es:papi:protocol'
Supported namespaces for attributes.


[ Top ]



PAPI_ATTRIBUTE_PARSER [line 103]

PAPI_ATTRIBUTE_PARSER = "PAPI_ATTRIBUTE_PARSER"
This hook is executed when returning the attributes found for a user with getAttributes() method. It receives a string with the attributes and the array that results of proccessing the string. Functions for this hook must be defined like this:

function attributeParser($assertion, &$attributes);

Please bear in mind that hooks must return TRUE or they'll keep other hooks from executing.



[ Top ]



PAPI_CLEAN_URL [line 92]

PAPI_CLEAN_URL = "PAPI_CLEAN_URL"
This hook is executed when a valid response is found from the AS/GPoA and the engine is about

to end the authentication result. It receives a boolean value that determines if the URL should be cleaned by means of a redirection to the initial URL. Functions for this hook must be defined like this:

function cleanURLHook(&$clean);

Please bear in mind that hooks must return TRUE or they'll keep other hooks from executing.



[ Top ]



PAPI_DBA [line 36]

PAPI_DBA = 'PAPIDBADB'
Supported database types.


[ Top ]



PAPI_MYSQL [line 37]

PAPI_MYSQL = 'PAPIMySQLDB'

[ Top ]



PAPI_REDIRECT_URL_FINISH [line 69]

PAPI_REDIRECT_URL_FINISH = "PAPI_REDIRECT_URL_FINISH"
This hook is executed at the end of the method that returns the URL where to redirect a user.

It can be used to alter parameters in the URL. The hook receives an array of parameters which should be directly modified. Functions for this hook must be defined like this:

function redirectURLFinishHook(&$params);

Please bear in mind that hooks must return TRUE or they'll keep other hooks from executing.



[ Top ]



PAPI_RESTORE_ORIGINAL_REQUEST [line 80]

PAPI_RESTORE_ORIGINAL_REQUEST = "PAPI_RESTORE_ORIGINAL_REQUEST"
This hook is executed when a valid response is found from the AS/GPoA and the original request of the user is about to be restored. It receives an array with the main PHP global variables of the original context. Functions for this hook must be defined like this:

function restoreOriginalRequestHook(&$env);

Please bear in mind that hooks must return TRUE or they'll keep other hooks from executing.



[ Top ]



PAPI_SESSION [line 38]

PAPI_SESSION = 'PAPISessionDB'

[ Top ]



PROTO_ATTR_AS_ID [line 51]

PROTO_ATTR_AS_ID = '__asid'

[ Top ]



PROTO_ATTR_EXPIRE_TIME [line 53]

PROTO_ATTR_EXPIRE_TIME = '__expiretime'

[ Top ]



PROTO_ATTR_KEY [line 52]

PROTO_ATTR_KEY = '__key'

[ Top ]



PROTO_ATTR_PREFIX [line 50]

PROTO_ATTR_PREFIX = '_papi_'
Prefix for operational attributes inside the protocol and special attributes names.


[ Top ]



REQUEST_LIFETIME [line 58]

REQUEST_LIFETIME = 300
Default timeout for stored requests.


[ Top ]



VALUE_SEPARATOR [line 30]

VALUE_SEPARATOR = "|"

[ Top ]




Documentation generated on Fri, 11 Feb 2011 10:58:00 +0100 by phpDocumentor 1.4.3