phpDocumentor
[ all elements ]

Index of All Elements

Package Indexes


[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ x ] [ z ] [ _ ]

a

a

$attributes
in file Device.php, variable DeviceConfig::$attributes
    Array passing all options to the device module.
addAttribute
in file Profile.php, method Profile::addAttribute()
    adds an attribute to this profile
addAttribute
in file IdP.php, method IdP::addAttribute()
    Adds an attribute for the IdP instance into the database. Multiple instances of the same attribute are supported.
addSupportedEapMethod
in file Profile.php, method Profile::addSupportedEapMethod()
    register new supported EAP method for this profile
availableOptions
in file Helper.php, function availableOptions()
b

b

$BASE_DIR
in file config-template.php, variable Config::$BASE_DIR
    Installation path of CAT on the system
beginFlushAttributes
in file IdP.php, method IdP::beginFlushAttributes()
    deletes all attributes in this profile except the _file ones, these are reported as array
beginFlushAttributes
in file Profile.php, method Profile::beginFlushAttributes()
    deletes all attributes in this profile except the _file ones, these are reported as array
bootstrapFederation
in file Federation.php, method Federation::bootstrapFederation()
    Lists all Identity Providers in this federation
c

c

commitFlushAttributes
in file Profile.php, method Profile::commitFlushAttributes()
    after a beginFlushAttributes, deletes all attributes which are in the tobedeleted array
commitFlushAttributes
in file IdP.php, method IdP::commitFlushAttributes()
    after a beginFlushAttributes, deletes all attributes which are in the tobedeleted array
Config
in file config-template.php, class Config
    This classes' members hold the configuration for CAT
config-template.php
procedural page config-template.php
copyFile
in file Device.php, method DeviceConfig::copyFile()
    Copy a file from the module location to the temporary directory.
country_list
in file Federation.php, method Federation::country_list()
common.inc
procedural page common.inc
d

d

$DEBUG_FILE
in file config-template.php, variable Config::$DEBUG_FILE
    Destination for debug logs
$DEBUG_LEVEL
in file config-template.php, variable Config::$DEBUG_LEVEL
    Verbosity of some of the core code. The following debug levels are supported:
$DEFAULT_LOCALE
in file config-template.php, variable Config::$DEFAULT_LOCALE
    Sets the default locale.
$device
in file DeviceFactory.php, variable DeviceFactory::$device
    Contains the produced device instance
DBConnection.php
procedural page DBConnection.php
Device.php
procedural page Device.php
DeviceFactory.php
procedural page DeviceFactory.php
DBConnection
in file DBConnection.php, class DBConnection
    This class is a singleton for establishing a connection to the database
debug
in file Helper.php, function debug()
der2pem
in file X509.php, method X509::der2pem()
description
in file Helper.php, function description()
destroy
in file Profile.php, method Profile::destroy()
    deletes the profile from database and uninstantiates itself
DeviceConfig
in file Device.php, class DeviceConfig
    This class defines the API for CAT module writers.
DeviceFactory
in file DeviceFactory.php, class DeviceFactory
    This factory instantiates a device module and makes it available in its member $device.
Devices
in file devices.php, class Devices
    The Devices class holds a list of all devices the CAT knows about
devices-template.php
procedural page devices-template.php
devices.php
procedural page devices.php
Device_mobileconfig
in file mobileconfig.php, class Device_mobileconfig
    This is the main implementation class of the module
Device_TestModule
in file TestModule.php, class Device_TestModule
    This is the main implementation class of the module
Device_Vista7
in file Vista7.php, class Device_Vista7
Device_welcomeletter
in file welcomeletter.php, class Device_welcomeletter
    This is the main implementation class of the module
downloadCA
in file X509.php, method X509::downloadCA()
downloadFile
in file Helper.php, function downloadFile()
dumpAttibutes
in file Device.php, method DeviceConfig::dumpAttibutes()
    dumps attributes for debugging purposes
e

e

$EAP_NONE
in file EAP.php, variable EAP::$EAP_NONE
EAP.php
procedural page EAP.php
EAP
in file EAP.php, class EAP
    Convenience functions for EAP types
error
in file Helper.php, function error()
f

f

$FAST_GTC
in file EAP.php, variable EAP::$FAST_GTC
$federation
in file IdP.php, variable IdP::$federation
    The shortname of this IdP's federation
$FPATH
in file Device.php, variable DeviceConfig::$FPATH
    stores the path to the temporary working directory for a module instance
Federation.php
procedural page Federation.php
FAST
in file EAP.php, constant FAST
Federation
in file Federation.php, class Federation
    This class represents an eduroam federation.
fetch_raw_db_data
in file Helper.php, function fetch_raw_db_data()
flushAttributes
in file Profile.php, method Profile::flushAttributes()
flushAttributes
in file IdP.php, method IdP::flushAttributes()
    deletes all attributes of this IdP from the database
flushSupportedEapMethods
in file Profile.php, method Profile::flushSupportedEapMethods()
    removes all supported EAP methods
g

g

getAnonymousIDSupport
in file Profile.php, method Profile::getAnonymousIDSupport()
    returns FALSE if anonymous outer ID support if disabled, or the realm if it is enabled
getAttributes
in file Profile.php, method Profile::getAttributes()
    getAttibutes() returnes an array of attributes, including options (as an array) if no argument is given, only the profile-wide options are returned
getAttributes
in file IdP.php, method IdP::getAttributes()
    retrieves the IdP-wide attributes
getCAs
in file Profile.php, method Profile::getCAs()
getCollapsedAttributes
in file Profile.php, method Profile::getCollapsedAttributes()
getEapMethodsinOrderOfPreference
in file Profile.php, method Profile::getEapMethodsinOrderOfPreference()
getRealm
in file Profile.php, method Profile::getRealm()
GTC
in file EAP.php, constant GTC
h

h

Helper.php
procedural page Helper.php
handle
in file DBConnection.php, method DBConnection::handle()
    This is the only usable function. It creates a database connection if it is not up yet, and returns a handle to the database connection on every call.
i

i

$identifier
in file Profile.php, variable Profile::$identifier
$identifier
in file IdP.php, variable IdP::$identifier
    The row index of this IdP in the database
$identifier
in file Federation.php, variable Federation::$identifier
    Textual short-hand representation of this Federation
$institution
in file Profile.php, variable Profile::$institution
IdP.php
procedural page IdP.php
IdP
in file IdP.php, class IdP
    This class represents an Identity Provider (IdP).
isBlacklisted
in file Profile.php, method Profile::isBlacklisted()
    Checks whether a combination of EAP type and device should be served, or rather redirected
isEapTypeDefinitionComplete
in file Profile.php, method Profile::isEapTypeDefinitionComplete()
k

k

$KB_DB
in file config-template.php, variable Config::$KB_DB
    Database name on the server
$KB_HOST
in file config-template.php, variable Config::$KB_HOST
    Database server that contains all the user data
$KB_PASS
in file config-template.php, variable Config::$KB_PASS
    Password to access the database
$KB_USER
in file config-template.php, variable Config::$KB_USER
    Username to access the database
l

l

$LANGUAGES
in file config-template.php, variable Config::$LANGUAGES
$LANGUAGES
in file config-template.php, variable Config::$LANGUAGES
    Available languages.
$lang_index
in file Device.php, variable DeviceConfig::$lang_index
listAllIdentityProviders
in file Federation.php, method Federation::listAllIdentityProviders()
listDevices
in file devices.php, method Devices::listDevices()
    Each device is defined as a three-element array within this array
listFederations
in file Federation.php, method Federation::listFederations()
    Lists all federations that exist in the database
listIdentityProviders
in file Federation.php, method Federation::listIdentityProviders()
    Lists all Identity Providers in this federation
listKnownEAPTypes
in file EAP.php, method EAP::listKnownEAPTypes()
listProfiles
in file IdP.php, method IdP::listProfiles()
    This function retrieves all registered profiles for this IdP from the database
m

m

$MAPS_API_KEY
in file config-template.php, variable Config::$MAPS_API_KEY
    Your API key for Google Maps. If this config variable is invalid, all the map parts won't work.
$MAX_UPLOAD_SIZE
in file config-template.php, variable Config::$MAX_UPLOAD_SIZE
    Maximum size of files to be uploaded. Clever people can circumvent this; in the end, the hard limit is configured in php.ini
$module_path
in file Device.php, variable DeviceConfig::$module_path
$my_eap_methods
in file mobileconfig.php, variable Device_mobileconfig::$my_eap_methods
mobileconfig.php
procedural page mobileconfig.php
MSCHAP2
in file EAP.php, constant MSCHAP2
n

n

$name
in file IdP.php, variable IdP::$name
    The name of this IdP
$name
in file Profile.php, variable Profile::$name
name
in file Federation.php, method Federation::name()
newIdP
in file Federation.php, method Federation::newIdP()
newProfile
in file IdP.php, method IdP::newProfile()
    Adds a new profile to this IdP.
NONE
in file EAP.php, constant NONE
p

p

$PEAP_MSCHAP2
in file EAP.php, variable EAP::$PEAP_MSCHAP2
$PLACES_API_KEY
in file config-template.php, variable Config::$PLACES_API_KEY
    The CAT uses Google places to guess a location based on the country and name. You need to have a valid Google Places API key for that. Note that this is different from the Google Maps API key, below.
Profile.php
procedural page Profile.php
peap_tls.inc
procedural page peap_tls.inc
PEAP
in file EAP.php, constant PEAP
    some constants. Will PHPDoc render these nicely?
pem2der
in file X509.php, method X509::pem2der()
    transform PEM formed certificate to DER format
processCertificate
in file X509.php, method X509::processCertificate()
    prepare PEM and DER formats, MD5 and SHA1 fingerprints and subject of the certificate
Profile
in file Profile.php, class Profile
    This class represents an EAP Profile.
r

r

$RADIUS_HOSTS
in file config-template.php, variable Config::$RADIUS_HOSTS
    The RADIUS proxies to contact for static realm reachability checks
$realm
in file Profile.php, variable Profile::$realm
registerBlacklist
in file Profile.php, method Profile::registerBlacklist()
    registers that a combination of device type and EAP method in this profile should NOT be served by CAT A redirect URL needs to be given to send the user to
s

s

$selected_eap
in file Device.php, variable DeviceConfig::$selected_eap
    optimal EAP method selected given profile and device
$sign
in file Device.php, variable DeviceConfig::$sign
saveCertificateFiles
in file Device.php, method DeviceConfig::saveCertificateFiles()
    Save certificate files in either DER or PEM format
setAnonymousIDSupport
in file Profile.php, method Profile::setAnonymousIDSupport()
    toggle anonID support
setName
in file Profile.php, method Profile::setName()
setRealm
in file Profile.php, method Profile::setRealm()
setup
in file Device.php, method DeviceConfig::setup()
    Set up working environment for a device module
set_locale
in file Helper.php, function set_locale()
t

t

$TLS
in file EAP.php, variable EAP::$TLS
$TMP_BASE_PATH
in file config-template.php, variable Config::$TMP_BASE_PATH
    Base path for temporary files (these will hold site installer data)
$TTLS_GTC
in file EAP.php, variable EAP::$TTLS_GTC
$TTLS_MSCHAP2
in file EAP.php, variable EAP::$TTLS_MSCHAP2
$TTLS_PAP
in file EAP.php, variable EAP::$TTLS_PAP
ttls.inc
procedural page ttls.inc
TestModule.php
procedural page TestModule.php
TLS
in file EAP.php, constant TLS
translateFile
in file Device.php, method DeviceConfig::translateFile()
    Copy a file from the module location to the temporary directory aplying translation.
TTLS
in file EAP.php, constant TTLS
u

u

$use_anon_outer
in file Profile.php, variable Profile::$use_anon_outer
unregisterBlacklist
in file Profile.php, method Profile::unregisterBlacklist()
    Deletes a previously set blacklist rule for EAP types and/or devices in this profile, including all more specific rules
uuid
in file Helper.php, function uuid()
    generates a UUID
v

v

Vista7.php
procedural page Vista7.php
w

w

$WEB_DIR
in file config-template.php, variable Config::$WEB_DIR
    Path to the web subdir of CAT on the system
welcomeletter.php
procedural page welcomeletter.php
writeInstaller
in file welcomeletter.php, method Device_welcomeletter::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
writeInstaller
in file Vista7.php, method Device_Vista7::writeInstaller()
writeInstaller
in file TestModule.php, method Device_TestModule::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
writeInstaller
in file Device.php, method DeviceConfig::writeInstaller()
    placeholder for the main device method
writeInstaller
in file mobileconfig.php, method Device_mobileconfig::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
x

x

X509.php
procedural page X509.php
X509
in file X509.php, class X509
    This class contains handling functions for X.509 certificates
z

z

zipInstaller
in file TestModule.php, method Device_TestModule::zipInstaller()
    zip files and return the archive name
_

_

_config.php
procedural page _config.php
__clone
in file DBConnection.php, method DBConnection::__clone()
    Implemented for safety reasons only. Cloning is forbidden and will tell the user so.
__construct
in file Vista7.php, method Device_Vista7::__construct()
__construct
in file welcomeletter.php, method Device_welcomeletter::__construct()
__construct
in file TestModule.php, method Device_TestModule::__construct()
    Constructs a Device object.
__construct
in file mobileconfig.php, method Device_mobileconfig::__construct()
    this array holds the list of EAP methods supported by this device
__construct
in file DeviceFactory.php, method DeviceFactory::__construct()
    The constructor of the device factory.
__construct
in file Federation.php, method Federation::__construct()
    Constructs a Federation object.
__construct
in file IdP.php, method IdP::__construct()
    Constructs an IdP object based on its details in the database.
__construct
in file Profile.php, method Profile::__construct()

Documentation generated on Fri, 05 Aug 2011 15:56:30 +0200 by phpDocumentor 1.4.3