Index of all elements
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
a
- $assertion
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$assertion
- $as_id
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$as_id
- $attributes
- in file PoA.php, variable PoA::$attributes
- $attributes
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$attributes
- $authn_engine
- in file PoA.php, variable PoA::$authn_engine
- $authorized
- in file AuthorizedDBADB.php, variable AuthorizedDBADB::$authorized
- $authz_db
- in file InviteAuthzEngine.php, variable InviteAuthzEngine::$authz_db
- $authz_engines
- in file PoA.php, variable PoA::$authz_engines
- $autoload
- in file PoA.php, variable PoA::$autoload
- abort
- in file PoAEventHandler.php, method PoAEventHandler::abort()
Finish execution and print an error message with the current backtrace.
- addHook
- in file GenericEngine.php, method GenericEngine::addHook()
Adds a function to the specified hook, which will be executed at some point of the code.
- addHook
- in file PoA.php, method PoA::addHook()
Attach a hook object to the appropriate entry point of the available authentication or authorization engines.
- AS_T
- in file definitions.php, constant AS_T
'AS' type redirection in the PAPI 1.5 protocol.
- attrHook
- in file papi1.5-attr-authz.php, function attrHook()
- AttributeFilterAuthzEngine
- in file AttributeFilterAuthzEngine.php, class AttributeFilterAuthzEngine
Authorization engine that works by checking the attributes of the user. The first match of an attribute against one of the filters will trigger the authorization result, no matter if it's positive or negative.
- AttributeFilterConfigurator
- in file AttributeFilterConfigurator.php, class AttributeFilterConfigurator
Configurator for the Attribute Filter Authorization Engine.
- AttributeHandler
- in file papi1.5-customattr.php, class AttributeHandler
- attributeQuery
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::attributeQuery()
- ATTRIBUTE_BEFORE_FILTERS
- in file AttributeFilterAuthzEngine.php, constant ATTRIBUTE_BEFORE_FILTERS
This hook is executed right after retrieving the arrays of allowed and denied attributes that will be checked inmediately.
- ATTR_SEPARATOR
- in file PAPIAuthnEngine.php, constant ATTR_SEPARATOR
Default assertion delimiters for standard PAPI 1.5 protocol.
- authenticate
- in file AutoPoA.php, method AutoPoA::authenticate()
- authenticate
- in file AuthenticationEngine.php, method AuthenticationEngine::authenticate()
Trigger the authentication of the user in the current context. May perform HTTP redirections or any other procedure to gather the authentication status if the user, so don't expect it to return control once called.
- authenticate
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::authenticate()
- authenticate
- in file PoA.php, method PoA::authenticate()
Perform a federated login for the user.
- AuthenticationEngine
- in file AuthenticationEngine.php, class AuthenticationEngine
Abstract authentication engine.
- AUTHN_FAILED
- in file definitions.php, constant AUTHN_FAILED
Authentication failed.
- AUTHN_SUCCESS
- in file definitions.php, constant AUTHN_SUCCESS
Authentication succeeded.
- AuthorizationConfigurator
- in file AuthorizationConfigurator.php, class AuthorizationConfigurator
- AuthorizationEngine
- in file AuthorizationEngine.php, class AuthorizationEngine
- authorize
- in file AuthorizationEngine.php, method AuthorizationEngine::authorize()
- authorize
- in file AttributeFilterAuthzEngine.php, method AttributeFilterAuthzEngine::authorize()
- authorize
- in file PoA.php, method PoA::authorize()
Authorize a given subject with the data retrieved from federated login.
- authorize
- in file InviteAuthzEngine.php, method InviteAuthzEngine::authorize()
Authorize the specified user.
- authorize
- in file SourceIPAddrAuthzEngine.php, method SourceIPAddrAuthzEngine::authorize()
- authorize
- in file QueryFilterAuthzEngine.php, method QueryFilterAuthzEngine::authorize()
- AuthorizedDB
- in file AuthorizedDB.php, class AuthorizedDB
Generic interface for a PAPI request database.
- AuthorizedDBADB
- in file AuthorizedDBADB.php, class AuthorizedDBADB
Authorization lists binding to a Berkeley DB backend.
- AUTHORIZED_DBA
- in file InviteAuthzEngine.php, constant AUTHORIZED_DBA
- AUTHORIZED_MYSQL
- in file InviteAuthzEngine.php, constant AUTHORIZED_MYSQL
- AUTHORIZED_SESSION
- in file InviteAuthzEngine.php, constant AUTHORIZED_SESSION
- AUTHZ_FAILED
- in file definitions.php, constant AUTHZ_FAILED
Authorization failed.
- AUTHZ_SUCCESS
- in file definitions.php, constant AUTHZ_SUCCESS
Authorization succeeded.
- autoloadHandler
- in file PoAEventHandler.php, method PoAEventHandler::autoloadHandler()
Override __autoload standard function to allow loading classes dinamically.
- AutoPoA
- in file AutoPoA.php, class AutoPoA
Class that automatically redirects to error pages if any error is detected.
- AutoPoA.php
- procedural page AutoPoA.php
- AuthenticationEngine.php
- procedural page AuthenticationEngine.php
- AttributeFilterAuthzEngine.php
- procedural page AttributeFilterAuthzEngine.php
- AttributeFilterConfigurator.php
- procedural page AttributeFilterConfigurator.php
- AuthorizationConfigurator.php
- procedural page AuthorizationConfigurator.php
- AuthorizationEngine.php
- procedural page AuthorizationEngine.php
- AuthorizedDB.php
- procedural page AuthorizedDB.php
- AuthorizedDBADB.php
- procedural page AuthorizedDBADB.php
- authz_convert.php
- procedural page authz_convert.php
top
c
- $cfg
- in file GenericDB.php, variable GenericDB::$cfg
- $cfg
- in file GenericConfigurator.php, variable GenericConfigurator::$cfg
- $cfg
- in file GenericEngine.php, variable GenericEngine::$cfg
- $cfg
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$cfg
- $cfg
- in file PoA.php, variable PoA::$cfg
- $clean_url
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$clean_url
- $context
- in file PAPIDBADB.php, variable PAPIDBADB::$context
- $context
- in file PAPIMySQLDB.php, variable PAPIMySQLDB::$context
- $context
- in file PAPISessionDB.php, variable PAPISessionDB::$context
- $cookie_name
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$cookie_name
- $create_sql
- in file GenericMySQLDB.php, variable GenericMySQLDB::$create_sql
- check
- in file SessionDB.php, method SessionDB::check()
- check
- in file GenericMySQLDB.php, method GenericMySQLDB::check()
- check
- in file GenericDB.php, method GenericDB::check()
Checks if the specified key exists in the database.
- check
- in file DBADB.php, method DBADB::check()
- checkAccess
- in file LitePoA.php, method LitePoA::checkAccess()
A shortcut for the whole authentication and authorization process.
- clean
- in file PoA.php, method PoA::clean()
- close
- in file GenericMySQLDB.php, method GenericMySQLDB::close()
- close
- in file DBADB.php, method DBADB::close()
- close
- in file GenericDB.php, method GenericDB::close()
Closes the database.
- close
- in file SessionDB.php, method SessionDB::close()
- configure
- in file GenericConfigurator.php, method GenericConfigurator::configure()
Read the configuration from the specified file and section.
- configure
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::configure()
- configure
- in file InviteAuthzEngine.php, method InviteAuthzEngine::configure()
Configure the authorization engine.
- configure
- in file GenericEngine.php, method GenericEngine::configure()
Configure the engine.
- configure
- in file GenericDB.php, method GenericDB::configure()
Configure the database handler.
- CONFIG_ERR
- in file definitions.php, constant CONFIG_ERR
A configuration related error.
- crypt.php
- procedural page crypt.php
top
d
- $db
- in file GenericDB.php, variable GenericDB::$db
- $db
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$db
- $db_manager
- in file PoA.php, variable PoA::$db_manager
- $delete_sql
- in file GenericMySQLDB.php, variable GenericMySQLDB::$delete_sql
- DBADB
- in file DBADB.php, class DBADB
Berkeley DB backend.
- decrypt_3DES
- in file crypt.php, function decrypt_3DES()
- decrypt_AES
- in file crypt.php, function decrypt_AES()
- definitions.php
- procedural page definitions.php
- delete
- in file SessionDB.php, method SessionDB::delete()
- delete
- in file GenericDB.php, method GenericDB::delete()
Removes the specified key from the database.
- delete
- in file GenericMySQLDB.php, method GenericMySQLDB::delete()
- delete
- in file DBADB.php, method DBADB::delete()
- deleteCookie
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::deleteCookie()
Delete the current cookie, if any.
- deleteRequest
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::deleteRequest()
Delete a request from the request database.
- doEmailVerify
- in file InviteConfigurator.php, method InviteConfigurator::doEmailVerify()
- DBADB.php
- procedural page DBADB.php
top
e
- $enforcing
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$enforcing
- $engine_type
- in file AuthenticationEngine.php, variable AuthenticationEngine::$engine_type
- $engine_type
- in file GenericEngine.php, variable GenericEngine::$engine_type
- $engine_type
- in file AuthorizationEngine.php, variable AuthorizationEngine::$engine_type
- $error
- in file GenericDB.php, variable GenericDB::$error
- $expiration_time
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$expiration_time
- emailVerify
- in file InviteAuthzEngine.php, method InviteAuthzEngine::emailVerify()
Perform e-mail verification for the current user according to the configuration for this site.
- encrypt_3DES
- in file crypt.php, function encrypt_3DES()
- encrypt_AES
- in file crypt.php, function encrypt_AES()
- errorHandler
- in file PoAEventHandler.php, method PoAEventHandler::errorHandler()
A generic error handler that logs the error message.
- Example
- in file papi1.5-papiopoa-hook.php, class Example
- exceptionHandler
- in file PoAEventHandler.php, method PoAEventHandler::exceptionHandler()
A generic exception handler that logs the exception message.
top
f
- fetch
- in file GenericMySQLDB.php, method GenericMySQLDB::fetch()
- fetch
- in file AuthorizedDBADB.php, method AuthorizedDBADB::fetch()
- fetch
- in file PAPIMySQLDB.php, method PAPIMySQLDB::fetch()
- fetch
- in file InviteDBADB.php, method InviteDBADB::fetch()
- fetch
- in file PAPISessionDB.php, method PAPISessionDB::fetch()
- fetch
- in file GenericDB.php, method GenericDB::fetch()
Gets the value of the specified key.
- fetch
- in file DBADB.php, method DBADB::fetch()
- fetch
- in file SessionDB.php, method SessionDB::fetch()
- fetch
- in file PAPIDBADB.php, method PAPIDBADB::fetch()
- fetch_all
- in file SessionDB.php, method SessionDB::fetch_all()
- fetch_all
- in file GenericMySQLDB.php, method GenericMySQLDB::fetch_all()
- fetch_all
- in file AuthorizedDBADB.php, method AuthorizedDBADB::fetch_all()
- fetch_all
- in file DBADB.php, method DBADB::fetch_all()
- fetch_all
- in file GenericDB.php, method GenericDB::fetch_all()
Gets all the contents stored in the database.
- fetch_all
- in file InviteDBADB.php, method InviteDBADB::fetch_all()
- finish
- in file InviteAuthzEngine.php, method InviteAuthzEngine::finish()
Close databases and return the same value received as a parameter.
top
g
- $global_expire_time
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$global_expire_time
- GenericConfigurator
- in file GenericConfigurator.php, class GenericConfigurator
Generic configuration class.
- GenericDB
- in file GenericDB.php, class GenericDB
Provides the basic operations and defines the interface of any DB operating class.
- GenericEngine
- in file GenericEngine.php, class GenericEngine
A generic engine class.
- GenericMySQLDB
- in file GenericMySQLDB.php, class GenericMySQLDB
Generic MySQL database class.
- getAdminEmail
- in file InviteConfigurator.php, method InviteConfigurator::getAdminEmail()
Returns
- getAllowed
- in file SourceIPAddrConfigurator.php, method SourceIPAddrConfigurator::getAllowed()
Returns an array of IP addresses or networks that are authorized.
- getAllowedAttributes
- in file AttributeFilterConfigurator.php, method AttributeFilterConfigurator::getAllowedAttributes()
Returns an array of attributes that would be allowed if their values match any of the patterns for each attribute.
- getAllowedPatterns
- in file QueryFilterConfigurator.php, method QueryFilterConfigurator::getAllowedPatterns()
Returns the patterns that match allowed URIs or query parameters.
- getAttribute
- in file PoA.php, method PoA::getAttribute()
Get the value (or values) of an attribute, if present.
- getAttribute
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::getAttribute()
- getAttribute
- in file AuthenticationEngine.php, method AuthenticationEngine::getAttribute()
Get an specific attribute for the current user, by specifying its name and namespace. May trigger some attribute query procedure.
- getAttributes
- in file PoA.php, method PoA::getAttributes()
Retrieve the attributes provided by the user when logged in.
- getAttributes
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::getAttributes()
- getAttributes
- in file AuthenticationEngine.php, method AuthenticationEngine::getAttributes()
Get an associative array with the set of common attributes for the current user. May trigger some attribute recollection.
- getAuthnEngine
- in file PoAConfigurator.php, method PoAConfigurator::getAuthnEngine()
- getAuthnEngineConfFile
- in file PoAConfigurator.php, method PoAConfigurator::getAuthnEngineConfFile()
- getAuthorizationEngines
- in file PoA.php, method PoA::getAuthorizationEngines()
Returns the authorization engines configured for the current PoA, or the one specified.
- getAuthorizedDBFile
- in file InviteConfigurator.php, method InviteConfigurator::getAuthorizedDBFile()
Returns
- getAuthorizedDBHost
- in file InviteConfigurator.php, method InviteConfigurator::getAuthorizedDBHost()
Returns
- getAuthorizedDBName
- in file InviteConfigurator.php, method InviteConfigurator::getAuthorizedDBName()
Returns
- getAuthorizedDBPassword
- in file InviteConfigurator.php, method InviteConfigurator::getAuthorizedDBPassword()
Returns
- getAuthorizedDBType
- in file InviteConfigurator.php, method InviteConfigurator::getAuthorizedDBType()
Returns
- getAuthorizedDBUser
- in file InviteConfigurator.php, method InviteConfigurator::getAuthorizedDBUser()
Returns
- getAuthorizedList
- in file SourceIPAddrAuthzEngine.php, method SourceIPAddrAuthzEngine::getAuthorizedList()
- getAuthorizedList
- in file AuthorizationEngine.php, method AuthorizationEngine::getAuthorizedList()
- getAuthorizedList
- in file AttributeFilterAuthzEngine.php, method AttributeFilterAuthzEngine::getAuthorizedList()
- getAuthorizedList
- in file QueryFilterAuthzEngine.php, method QueryFilterAuthzEngine::getAuthorizedList()
- getAuthorizedList
- in file InviteAuthzEngine.php, method InviteAuthzEngine::getAuthorizedList()
Get a list of all authorized users.
- getAuthzEngineConfFile
- in file PoAConfigurator.php, method PoAConfigurator::getAuthzEngineConfFile()
- getAuthzEngines
- in file PoAConfigurator.php, method PoAConfigurator::getAuthzEngines()
- getCookieDomain
- in file PAPIConfigurator.php, method PAPIConfigurator::getCookieDomain()
- getCookieTimeout
- in file PAPIConfigurator.php, method PAPIConfigurator::getCookieTimeout()
- getDBFile
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBFile()
- getDBHost
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBHost()
- getDBName
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBName()
- getDBPassword
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBPassword()
- getDBPrefix
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBPrefix()
- getDBType
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBType()
- getDBUser
- in file PAPIConfigurator.php, method PAPIConfigurator::getDBUser()
- getDefaultBehaviour
- in file AuthorizationConfigurator.php, method AuthorizationConfigurator::getDefaultBehaviour()
Determines the default behaviour of the authorization engine, whether it should authorize or not if no pattern (nor allowed nor denied) matches.
- getDenied
- in file SourceIPAddrConfigurator.php, method SourceIPAddrConfigurator::getDenied()
Returns an array of IP addresses or networks that are not authorized.
- getDeniedAttributes
- in file AttributeFilterConfigurator.php, method AttributeFilterConfigurator::getDeniedAttributes()
Returns an array of attributes that would be denied if their values match any of the patterns for each attribute.
- getDeniedPatterns
- in file QueryFilterConfigurator.php, method QueryFilterConfigurator::getDeniedPatterns()
Returns the patterns that match denied URIs or query parameters.
- getEmailVerifyAlgRegEx
- in file InviteConfigurator.php, method InviteConfigurator::getEmailVerifyAlgRegEx()
- getEmailVerifyAttribute
- in file InviteConfigurator.php, method InviteConfigurator::getEmailVerifyAttribute()
- getEmailVerifyRegEx
- in file InviteConfigurator.php, method InviteConfigurator::getEmailVerifyRegEx()
- getError
- in file GenericMySQLDB.php, method GenericMySQLDB::getError()
- getFriendlyName
- in file PAPIConfigurator.php, method PAPIConfigurator::getFriendlyName()
- getHomeLocatorID
- in file PAPIConfigurator.php, method PAPIConfigurator::getHomeLocatorID()
- getID
- in file PAPIConfigurator.php, method PAPIConfigurator::getID()
- getInviteErrorURL
- in file PoAConfigurator.php, method PoAConfigurator::getInviteErrorURL()
- getInvitesDBFile
- in file InviteConfigurator.php, method InviteConfigurator::getInvitesDBFile()
Returns
- getInvitesDBHost
- in file InviteConfigurator.php, method InviteConfigurator::getInvitesDBHost()
Returns
- getInvitesDBName
- in file InviteConfigurator.php, method InviteConfigurator::getInvitesDBName()
Returns
- getInvitesDBPassword
- in file InviteConfigurator.php, method InviteConfigurator::getInvitesDBPassword()
Returns
- getInvitesDBType
- in file InviteConfigurator.php, method InviteConfigurator::getInvitesDBType()
Returns
- getInvitesDBUser
- in file InviteConfigurator.php, method InviteConfigurator::getInvitesDBUser()
Returns
- getInviteSubject
- in file InviteConfigurator.php, method InviteConfigurator::getInviteSubject()
Returns
- getInviteText
- in file InviteConfigurator.php, method InviteConfigurator::getInviteText()
Returns
- getInviteURL
- in file InviteConfigurator.php, method InviteConfigurator::getInviteURL()
Returns
- getLanguage
- in file PoAConfigurator.php, method PoAConfigurator::getLanguage()
- getLKey
- in file PAPIConfigurator.php, method PAPIConfigurator::getLKey()
- getLocation
- in file PAPIConfigurator.php, method PAPIConfigurator::getLocation()
- getLogFile
- in file PoAConfigurator.php, method PoAConfigurator::getLogFile()
- getLogLevel
- in file PoAConfigurator.php, method PoAConfigurator::getLogLevel()
- getLogLevel
- in file PoALog.php, method PoALog::getLogLevel()
Get the current log level.
- getLogoutURL
- in file PAPIConfigurator.php, method PAPIConfigurator::getLogoutURL()
- getName
- in file Hook.php, method Hook::getName()
Get the name of the hook.
- getNewCookie
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::getNewCookie()
Generate a new cookie for the current user.
- getNoAuthErrorURL
- in file PoAConfigurator.php, method PoAConfigurator::getNoAuthErrorURL()
- getPendingInvites
- in file InviteAuthzEngine.php, method InviteAuthzEngine::getPendingInvites()
Get a list of all pending invitations.
- getPubKeyFile
- in file PAPIConfigurator.php, method PAPIConfigurator::getPubKeyFile()
- getRedirectLocation
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::getRedirectLocation()
Retrieve the URL where to redirect a user and store his request.
- getRedirectType
- in file PAPIConfigurator.php, method PAPIConfigurator::getRedirectType()
- getRedirectURL
- in file PAPIConfigurator.php, method PAPIConfigurator::getRedirectURL()
- getRequestLifetime
- in file PAPIConfigurator.php, method PAPIConfigurator::getRequestLifetime()
- getSingleLogoutLocation
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::getSingleLogoutLocation()
Retrieve the URL where to redirect a user to perform a single logout.
- getSingleLogoutResponseLocation
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::getSingleLogoutResponseLocation()
Retrieve the URL where to redirect a user once he has successfully logged out.
- getSystemErrorURL
- in file PoAConfigurator.php, method PoAConfigurator::getSystemErrorURL()
- getUniqueAttributes
- in file InviteConfigurator.php, method InviteConfigurator::getUniqueAttributes()
Returns
- GPOA_T
- in file definitions.php, constant GPOA_T
'GPoA' type redirection in the PAPI 1.5 protocol.
- GenericDB.php
- procedural page GenericDB.php
- GenericMySQLDB.php
- procedural page GenericMySQLDB.php
- GenericConfigurator.php
- procedural page GenericConfigurator.php
- GenericEngine.php
- procedural page GenericEngine.php
top
top
i
- $id
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$id
- $insert_sql
- in file GenericMySQLDB.php, variable GenericMySQLDB::$insert_sql
- $invite
- in file InviteDBADB.php, variable InviteDBADB::$invite
- $invites_db
- in file InviteAuthzEngine.php, variable InviteAuthzEngine::$invites_db
- invite
- in file InviteAuthzEngine.php, method InviteAuthzEngine::invite()
Send an invitation to an e-mail address (that is, send an e-mail to that address with instructions on how to get authorized and an URL to follow).
- InviteAuthzEngine
- in file InviteAuthzEngine.php, class InviteAuthzEngine
Invitation based authorization engine.
- InviteConfigurator
- in file InviteConfigurator.php, class InviteConfigurator
Configurator for the Invitation based authorization engine.
- InviteDB
- in file InviteDB.php, class InviteDB
Generic interface for a database of invites.
- InviteDBADB
- in file InviteDBADB.php, class InviteDBADB
Invites binding to a Berkeley DB backend.
- INVITES_BEFORE_AUTHORIZATION
- in file InviteAuthzEngine.php, constant INVITES_BEFORE_AUTHORIZATION
This hook is executed right before it is checked whether the user was invited or not to continue with authorization.
- INVITES_DBA
- in file InviteAuthzEngine.php, constant INVITES_DBA
Supported database types.
- INVITES_MYSQL
- in file InviteAuthzEngine.php, constant INVITES_MYSQL
- INVITES_SESSION
- in file InviteAuthzEngine.php, constant INVITES_SESSION
- INVITE_ERR
- in file definitions.php, constant INVITE_ERR
An invitation related error.
- ipHook
- in file papi1.5-ip-authz.php, function ipHook()
- isAuthenticated
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::isAuthenticated()
- isAuthenticated
- in file PoA.php, method PoA::isAuthenticated()
Query the current status of the user in the federation.
- isAuthenticated
- in file AuthenticationEngine.php, method AuthenticationEngine::isAuthenticated()
Check the current authentication status withing this context. Does not trigger any authentication procedure.
- isAuthorized
- in file PoA.php, method PoA::isAuthorized()
Perform authorization for the a given subject.
- isAuthorized
- in file QueryFilterAuthzEngine.php, method QueryFilterAuthzEngine::isAuthorized()
- isAuthorized
- in file AutoPoA.php, method AutoPoA::isAuthorized()
- isAuthorized
- in file SourceIPAddrAuthzEngine.php, method SourceIPAddrAuthzEngine::isAuthorized()
- isAuthorized
- in file InviteAuthzEngine.php, method InviteAuthzEngine::isAuthorized()
Check if the specified user is authorized with the given attributes.
- isAuthorized
- in file AuthorizationEngine.php, method AuthorizationEngine::isAuthorized()
Check authorization for the specified user.
- isAuthorized
- in file AttributeFilterAuthzEngine.php, method AttributeFilterAuthzEngine::isAuthorized()
- isDebug
- in file PoAConfigurator.php, method PoAConfigurator::isDebug()
- isSafe
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::isSafe()
Determines if it's safe to assume the user as authenticated.
- InviteAuthzEngine.php
- procedural page InviteAuthzEngine.php
- InviteConfigurator.php
- procedural page InviteConfigurator.php
- InviteDB.php
- procedural page InviteDB.php
- InviteDBADB.php
- procedural page InviteDBADB.php
- invite_convert.php
- procedural page invite_convert.php
top
top
l
- $lkey
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$lkey
- $local_site
- in file PoA.php, variable PoA::$local_site
- $log
- in file PoA.php, variable PoA::$log
- lang_code
- in file utils.php, function lang_code()
Return the language code identifying applicable to a messages file.
- LitePoA
- in file LitePoA.php, class LitePoA
Class that embbeds all functionallity (authentication, attribute collection and authorization) in one method, just like older versions of phpPoA.
- LitePoA.php
- procedural page LitePoA.php
- loadRequest
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::loadRequest()
Load a request from the request database.
- logout
- in file AuthenticationEngine.php, method AuthenticationEngine::logout()
Perform a logout (locally or global).
- logout
- in file PoA.php, method PoA::logout()
Remove the user's session and trigger a logout for the specified authentication protocol.
- logout
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::logout()
top
m
- $mandatory_options
- in file PAPIConfigurator.php, variable PAPIConfigurator::$mandatory_options
- $mandatory_options
- in file AttributeFilterConfigurator.php, variable AttributeFilterConfigurator::$mandatory_options
- $mandatory_options
- in file PoAConfigurator.php, variable PoAConfigurator::$mandatory_options
- $mandatory_options
- in file QueryFilterConfigurator.php, variable QueryFilterConfigurator::$mandatory_options
- $mandatory_options
- in file SourceIPAddrConfigurator.php, variable SourceIPAddrConfigurator::$mandatory_options
- $mandatory_options
- in file InviteConfigurator.php, variable InviteConfigurator::$mandatory_options
- $mandatory_options
- in file InviteDBADB.php, variable InviteDBADB::$mandatory_options
- $mandatory_options
- in file GenericConfigurator.php, variable GenericConfigurator::$mandatory_options
- $mandatory_options
- in file DBADB.php, variable DBADB::$mandatory_options
- $mandatory_options
- in file AuthorizedDBADB.php, variable AuthorizedDBADB::$mandatory_options
- $mandatory_options
- in file GenericMySQLDB.php, variable GenericMySQLDB::$mandatory_options
- $mandatory_options
- in file GenericDB.php, variable GenericDB::$mandatory_options
- $messages
- in file messages-en_EN.php, global variable $messages
An array with all the internationalized messages used by phpPoA2.
- messages-en_EN.php
- procedural page messages-en_EN.php
- messages-es_ES.php
- procedural page messages-es_ES.php
- msg
- in file utils.php, function msg()
Return the internationalized message identified by the code 's'.
top
n
- NAMEVALUE_SEPARATOR
- in file PAPIAuthnEngine.php, constant NAMEVALUE_SEPARATOR
- NOAUTH_ERR
- in file definitions.php, constant NOAUTH_ERR
Authentication failed error.
- NS_PAPI_ATTRIBUTES
- in file PAPIAuthnEngine.php, constant NS_PAPI_ATTRIBUTES
- NS_PAPI_PROTOCOL
- in file PAPIAuthnEngine.php, constant NS_PAPI_PROTOCOL
Supported namespaces for attributes.
top
top
p
- $pkey
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$pkey
- $prefix
- in file PAPIMySQLDB.php, variable PAPIMySQLDB::$prefix
- $prefix
- in file GenericMySQLDB.php, variable GenericMySQLDB::$prefix
- PAPIAuthnEngine.php
- procedural page PAPIAuthnEngine.php
- PAPIConfigurator.php
- procedural page PAPIConfigurator.php
- PAPIDB.php
- procedural page PAPIDB.php
- PAPIDBADB.php
- procedural page PAPIDBADB.php
- PAPIMySQLDB.php
- procedural page PAPIMySQLDB.php
- PAPISessionDB.php
- procedural page PAPISessionDB.php
- PADDINGSIZE
- in file crypt.php, constant PADDINGSIZE
- PAPIAuthnEngine
- in file PAPIAuthnEngine.php, class PAPIAuthnEngine
Authentication engine for the PAPI 1.5 protocol.
- PAPIConfigurator
- in file PAPIConfigurator.php, class PAPIConfigurator
Configurator class for the PAPI Authentication Engine.
- PAPIDB
- in file PAPIDB.php, class PAPIDB
Generic interface for a PAPI request database.
- PAPIDBADB
- in file PAPIDBADB.php, class PAPIDBADB
PAPI binding to a Berkeley DB backend.
- PAPIMySQLDB
- in file PAPIMySQLDB.php, class PAPIMySQLDB
MySQL database frontend for the PAPI Authentication Engine.
- PAPISessionDB
- in file PAPISessionDB.php, class PAPISessionDB
PAPI binding to a PHP Session DB backend.
- PAPI_ATTRIBUTE_PARSER
- in file PAPIAuthnEngine.php, constant 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:
- PAPI_CLEAN_URL
- in file PAPIAuthnEngine.php, constant PAPI_CLEAN_URL
This hook is executed when a valid response is found from the AS/GPoA and the engine is about
- PAPI_DBA
- in file PAPIAuthnEngine.php, constant PAPI_DBA
Supported database types.
- PAPI_DB_TABLE
- in file PAPIMySQLDB.php, constant PAPI_DB_TABLE
- PAPI_MYSQL
- in file PAPIAuthnEngine.php, constant PAPI_MYSQL
- papi_openssl_decrypt
- in file crypt.php, function papi_openssl_decrypt()
- papi_openssl_encrypt
- in file crypt.php, function papi_openssl_encrypt()
- PAPI_REDIRECT_URL_FINISH
- in file PAPIAuthnEngine.php, constant PAPI_REDIRECT_URL_FINISH
This hook is executed at the end of the method that returns the URL where to redirect a user.
- PAPI_RESTORE_ORIGINAL_REQUEST
- in file PAPIAuthnEngine.php, constant 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:
- PAPI_SESSION
- in file PAPIAuthnEngine.php, constant PAPI_SESSION
- PoA
- in file PoA.php, class PoA
Standard class that implements all the functionallity of the phpPoA.
- PoA.php
- procedural page PoA.php
- PoAConfigurator
- in file PoAConfigurator.php, class PoAConfigurator
Main configurator for the phpPoA.
- PoAConfigurator.php
- procedural page PoAConfigurator.php
- PoAEventHandler
- in file PoAEventHandler.php, class PoAEventHandler
Class to handle events inside the library.
- PoAEventHandler.php
- procedural page PoAEventHandler.php
- PoAException
- in file PoAException.php, class PoAException
Exception handler class for the phpPoA.
- PoAException.php
- procedural page PoAException.php
- PoALog
- in file PoALog.php, class PoALog
A simple class to write log messages to a file.
- PoALog.php
- procedural page PoALog.php
- PROTO_ATTR_AS_ID
- in file PAPIAuthnEngine.php, constant PROTO_ATTR_AS_ID
- PROTO_ATTR_EXPIRE_TIME
- in file PAPIAuthnEngine.php, constant PROTO_ATTR_EXPIRE_TIME
- PROTO_ATTR_KEY
- in file PAPIAuthnEngine.php, constant PROTO_ATTR_KEY
- PROTO_ATTR_PREFIX
- in file PAPIAuthnEngine.php, constant PROTO_ATTR_PREFIX
Prefix for operational attributes inside the protocol and special attributes names.
- purge
- in file PAPIDB.php, method PAPIDB::purge()
Purge the database of outdated requests.
- purge
- in file PAPIDBADB.php, method PAPIDBADB::purge()
- papi1.5-attr-authz.php
- procedural page papi1.5-attr-authz.php
- papi1.5-authn-attr.php
- procedural page papi1.5-authn-attr.php
- papi1.5-customattr.php
- procedural page papi1.5-customattr.php
- papi1.5-invite-authz.php
- procedural page papi1.5-invite-authz.php
- papi1.5-ip-authz.php
- procedural page papi1.5-ip-authz.php
- papi1.5-papiopoa-hook.php
- procedural page papi1.5-papiopoa-hook.php
- papi1.5-query-authz.php
- procedural page papi1.5-query-authz.php
- papi1.5-slo-extra.php
- procedural page papi1.5-slo-extra.php
- papi1.5-slo.php
- procedural page papi1.5-slo.php
top
q
- QueryFilterAuthzEngine.php
- procedural page QueryFilterAuthzEngine.php
- QueryFilterConfigurator.php
- procedural page QueryFilterConfigurator.php
- QueryFilterAuthzEngine
- in file QueryFilterAuthzEngine.php, class QueryFilterAuthzEngine
Authorization engine that works by checking the query string of the request.
- QueryFilterConfigurator
- in file QueryFilterConfigurator.php, class QueryFilterConfigurator
Configurator for the query filter authorization engine.
- queryHook
- in file papi1.5-query-authz.php, function queryHook()
- QUERY_BEFORE_FILTERS
- in file QueryFilterAuthzEngine.php, constant QUERY_BEFORE_FILTERS
This hook is executed right after retrieving the current URI, the params (both GET and POST) and the arrays of allowed and denied patterns that will be checked inmediately.
top
r
- redirect
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::redirect()
Redirect user browser to the appropriate URL for authentication.
- removeHook
- in file PoA.php, method PoA::removeHook()
Remove a hook from the specified entry point of the available authentication or authorization engines.
- removeHook
- in file GenericEngine.php, method GenericEngine::removeHook()
Removes a function fromt he specified hook.
- removeInvite
- in file InviteAuthzEngine.php, method InviteAuthzEngine::removeInvite()
Remove an invitation from the database.
- replace
- in file GenericMySQLDB.php, method GenericMySQLDB::replace()
- replace
- in file GenericDB.php, method GenericDB::replace()
Replaces the specified key with a new value. If the key does not exist previously, it will be created.
- replace
- in file DBADB.php, method DBADB::replace()
- replace
- in file SessionDB.php, method SessionDB::replace()
- replaceContents
- in file PAPIMySQLDB.php, method PAPIMySQLDB::replaceContents()
- replaceContents
- in file PAPISessionDB.php, method PAPISessionDB::replaceContents()
- replaceContents
- in file PAPIDB.php, method PAPIDB::replaceContents()
- replaceContents
- in file PAPIDBADB.php, method PAPIDBADB::replaceContents()
- replace_authorization
- in file AuthorizedDB.php, method AuthorizedDB::replace_authorization()
- replace_authorization
- in file AuthorizedDBADB.php, method AuthorizedDBADB::replace_authorization()
- replace_invite
- in file InviteDBADB.php, method InviteDBADB::replace_invite()
- replace_invite
- in file InviteDB.php, method InviteDB::replace_invite()
- REQUEST_LIFETIME
- in file PAPIAuthnEngine.php, constant REQUEST_LIFETIME
Default timeout for stored requests.
- revoke
- in file QueryFilterAuthzEngine.php, method QueryFilterAuthzEngine::revoke()
- revoke
- in file AuthorizationEngine.php, method AuthorizationEngine::revoke()
- revoke
- in file PoA.php, method PoA::revoke()
Revoke authorization for a given subject identified by an e-mail.
- revoke
- in file InviteAuthzEngine.php, method InviteAuthzEngine::revoke()
Revoke authorization for the specified user.
- revoke
- in file SourceIPAddrAuthzEngine.php, method SourceIPAddrAuthzEngine::revoke()
- revoke
- in file AttributeFilterAuthzEngine.php, method AttributeFilterAuthzEngine::revoke()
- ROOT
- in file authz_convert.php, constant ROOT
Authorized DB converter tool from phpPoA1 to phpPoA2.
- run
- in file Hook.php, method Hook::run()
Run the hook with the specified params.
- runHooks
- in file GenericEngine.php, method GenericEngine::runHooks()
Run all hooks attached to an specific action.
top
s
- $search_all_sql
- in file GenericMySQLDB.php, variable GenericMySQLDB::$search_all_sql
- $search_sql
- in file GenericMySQLDB.php, variable GenericMySQLDB::$search_sql
- $session_name
- in file SessionDB.php, variable SessionDB::$session_name
- $skip_redirection
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$skip_redirection
- $status
- in file PAPIAuthnEngine.php, variable PAPIAuthnEngine::$status
- SourceIPAddrAuthzEngine.php
- procedural page SourceIPAddrAuthzEngine.php
- SourceIPAddrConfigurator.php
- procedural page SourceIPAddrConfigurator.php
- SessionDB.php
- procedural page SessionDB.php
- saveRequest
- in file PAPIAuthnEngine.php, method PAPIAuthnEngine::saveRequest()
Save a request to the request database. The request includes: $_REQUEST, $_GET, $_POST, $_SERVER['QUERY_STRING'], $_SERVER['REQUEST_METHOD'] and php://input.
- SessionDB
- in file SessionDB.php, class SessionDB
Session database backend.
- setDebug
- in file PoAEventHandler.php, method PoAEventHandler::setDebug()
Set debugging mode.
- setIDBuilder
- in file LitePoA.php, method LitePoA::setIDBuilder()
Set an attribute handler to build identifiers for the users according to their attributes. Method must receive a hash of attributes ("name" => "value").
- setLogger
- in file PoAEventHandler.php, method PoAEventHandler::setLogger()
Set the logger.
- SOURCEADDR_BEFORE_FILTERS
- in file SourceIPAddrAuthzEngine.php, constant SOURCEADDR_BEFORE_FILTERS
This hook is executed right after retrieving source address and the arrays of allowed and denied patterns that will be checked inmediately.
- SourceIPAddrAuthzEngine
- in file SourceIPAddrAuthzEngine.php, class SourceIPAddrAuthzEngine
Authorization engine that works by checking the source IP address of the request.
- SourceIPAddrConfigurator
- in file SourceIPAddrConfigurator.php, class SourceIPAddrConfigurator
Configurator class for the Source IP Address Authorization Engine.
- SYSTEM_ERR
- in file definitions.php, constant SYSTEM_ERR
A system related error.
top
top
top
top
w
- write
- in file PoALog.php, method PoALog::write()
Write a message to the log file if the current log level allows it.
top
_
- $_callable_name
- in file Hook.php, variable Hook::$_callable_name
- $_hook
- in file Hook.php, variable Hook::$_hook
- $_name
- in file Hook.php, variable Hook::$_name
- __construct
- in file PoAEventHandler.php, method PoAEventHandler::__construct()
Main constructor.
- __construct
- in file PoAConfigurator.php, method PoAConfigurator::__construct()
- __construct
- in file PoALog.php, method PoALog::__construct()
Build a new logger.
- __construct
- in file PoA.php, method PoA::__construct()
Main constructor. Configures the PoA and performs initialization.
- __construct
- in file PoAException.php, method PoAException::__construct()
- __construct
- in file Hook.php, method Hook::__construct()
Build a new hook.
- __construct
- in file GenericDB.php, method GenericDB::__construct()
Main constructor.
- __construct
- in file PAPIMySQLDB.php, method PAPIMySQLDB::__construct()
- __construct
- in file GenericEngine.php, method GenericEngine::__construct()
Main constructor for the engine.
- __construct
- in file GenericConfigurator.php, method GenericConfigurator::__construct()
Main constructor.
- __toString
- in file PoAException.php, method PoAException::__toString()
top
|
|