Index of All Elements
Package Indexes
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ j ]
[ k ]
[ l ]
[ m ]
[ n ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ x ]
[ _ ]
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
- AVAILABLE
- in file Profile.php, constant AVAILABLE
- availableOptions
- in file Helper.php, function availableOptions()
b
- beginFlushAttributes
- in file Profile.php, method Profile::beginFlushAttributes()
deletes all attributes in this profile except the _file ones, these are reported as array
- beginFlushAttributes
- in file IdP.php, method IdP::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
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 IdP.php, method IdP::destroy()
deletes the IdP and all its profiles
- 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_macosx
- in file macosx.php, class Device_macosx
This is the main implementation class of the module
- 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
- Device_WindowsXP
- in file WindowsXP.php, class Device_WindowsXP
- displayDeviceStatus
- in file simple.php, function displayDeviceStatus()
- 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
- download.php
- procedural page download.php
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
- EAPMethodIdFromArray
- in file Helper.php, function EAPMethodIdFromArray()
- error
- in file Helper.php, function error()
g
- generateInstaller
- in file GUI.php, method JSON::generateInstaller()
Call installer generation and return the link
- generateInstaller
- in file GUI.php, method GUI::generateInstaller()
Prepare the device module environment and send back the link
- 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 IdP.php, method IdP::getAttributes()
retrieves the IdP-wide attributes
- 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
- getCAs
- in file Profile.php, method Profile::getCAs()
- getCollapsedAttributes
- in file Profile.php, method Profile::getCollapsedAttributes()
- getEapMethodsinOrderOfPreference
- in file Profile.php, method Profile::getEapMethodsinOrderOfPreference()
produces an array of EAP methods supported by this profile, ordered by reference
- getPreferredEapType
- in file Device.php, method DeviceConfig::getPreferredEapType()
select the preferred eap method
- getRealm
- in file Profile.php, method Profile::getRealm()
- Globals
- in file Helper.php, class Globals
Define some variables which need to be globally accessible
- GTC
- in file EAP.php, constant GTC
- GUI
- in file GUI.php, class GUI
The basic methoods for the user GUI
- GUI.php
- procedural page GUI.php
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
- $identifier
- in file Profile.php, variable Profile::$identifier
- $identifier
- in file Federation.php, variable Federation::$identifier
Textual short-hand representation of this Federation
- $identifier
- in file IdP.php, variable IdP::$identifier
The row index of this IdP in the database
- $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).
- INCOMPLETE
- in file Profile.php, constant INCOMPLETE
- isAttributeAvailable
- in file IdP.php, method IdP::isAttributeAvailable()
This function returns the count of specific attributes in an IdP This function will not retreive the values attributes (particularly important for large blobs), it is mainly intended as a test for an attribute existance.
- 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()
- index.php
- procedural page index.php
j
- JSON
- in file GUI.php, class JSON
JSON methods are the inteface between the GUI methods and the cat_back.php backend
k
- $KB_CAT_PASS
- in file config-template.php, variable Config::$KB_CAT_PASS
Username to access the database
- $KB_CAT_USER
- in file config-template.php, variable Config::$KB_CAT_USER
Username to access the database for the user GUI
- $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
Password to access the database
l
- $LANGUAGES
- in file config-template.php, variable Config::$LANGUAGES
- $lang_index
- in file Helper.php, variable Globals::$lang_index
Current language setting (en, de, pl, etc.)
- $lang_index
- in file Device.php, variable DeviceConfig::$lang_index
the string referencing the language (index ot the Config::$LANGUAGES array it is set to the current language and may be used by the device module to set its language
- 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
- listDevices
- in file Profile.php, method Profile::listDevices()
list all devices marking their availabiblity
- 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
- listIdentityProvidersForDisco
- in file GUI.php, method JSON::listIdentityProvidersForDisco()
Produce the list of all available identity providers in the DiscoJuice format This is the DiscoJuice metadata producer
- 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
- listProfiles
- in file GUI.php, method JSON::listProfiles()
Produce a list of profiles available for a given IdP
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
stores the path to the module source location and is used by copyFile and translateFile the only reason for it to be a public variable ies that it is set by the DeviceFactory class module_path should not be used by module drivers.
- $my_eap_methods
- in file macosx.php, variable Device_macosx::$my_eap_methods
- $my_eap_methods
- in file mobileconfig.php, variable Device_mobileconfig::$my_eap_methods
- macosx.php
- procedural page macosx.php
- mobileconfig.php
- procedural page mobileconfig.php
- MSCHAP2
- in file EAP.php, constant MSCHAP2
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.
- $PRODUCT_NAME
- in file config-template.php, variable Config::$PRODUCT_NAME
- $PRODUCT_NAME_LONG
- in file config-template.php, variable Config::$PRODUCT_NAME_LONG
- 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
- printCountryList
- in file Federation.php, method Federation::printCountryList()
Prepares a list of countries known to the CAT
- printLn
- in file simple.php, function printLn()
- 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.
- profileAttributes
- in file GUI.php, method JSON::profileAttributes()
Produce support data prepared within GUI::profileAttributes()
- profileAttributes
- in file GUI.php, method GUI::profileAttributes()
Prepare the support data for a given profile
- profileCount
- in file IdP.php, method IdP::profileCount()
This function gets the profile count for a given IdP The count could be retreived from the listProfiles method but this is less expensive.
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
- $root
- in file Helper.php, variable Globals::$root
CAT source location
- 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
t
- $thedomain
- in file Helper.php, variable Globals::$thedomain
Current gettext domain set by set_locale()
- $thelang
- in file Helper.php, variable Globals::$thelang
Current language name
- $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
- 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
- $use_anon_outer
- in file Profile.php, variable Profile::$use_anon_outer
- UNAVAILABLE
- in file Profile.php, constant UNAVAILABLE
- 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
x
- X509.php
- procedural page X509.php
- X509
- in file X509.php, class X509
This class contains handling functions for X.509 certificates
_
- _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 TestModule.php, method Device_TestModule::__construct()
Constructs a Device object.
- __construct
- in file Vista7.php, method Device_Vista7::__construct()
- __construct
- in file welcomeletter.php, method Device_welcomeletter::__construct()
- __construct
- in file WindowsXP.php, method Device_WindowsXP::__construct()
- __construct
- in file Profile.php, method Profile::__construct()
- __construct
- in file mobileconfig.php, method Device_mobileconfig::__construct()
this array holds the list of EAP methods supported by this device
- __construct
- in file Device.php, method DeviceConfig::__construct()
device module constructor should be defined by each module, but if it is not, then here is a default one
- __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 macosx.php, method Device_macosx::__construct()
this array holds the list of EAP methods supported by this device
|
|