Classes, interfaces, and traits

SsoAdministrable

All DAO that can be modified in administration page will implement it

« More »

SsoAuthMethodInterface

Interface for Authentication Methods

« More »

SsoGroupable

All DAO that can be grouped will implements it.

« More »

AuthUser

User found in an auth method

« More »

BusinessException

Business Exception class

« More »

ErrorHandler

Handle error

« More »

Handler

Parent class of application plugin handlers

« More »

HiddenTheme

Class for hidden menu theme

« More »

Locale

Initialize and set locale for SSO

« More »

MobileTheme

Theme for menu with "mobile" look

« More »

RecommendedTheme

Recommended Theme.

« More »

Session

Session class

« More »

Sso

Sso "private" class : can be used in SSO but not in Applications

« More »

SsoAdmin

Parent class for all Administrable objects

« More »

SsoAdminApi

Allow other applications to retrieve SSO data with this class if current user is SSO admin

« More »

SsoAppli

SsoAppli

« More »

SsoAppliAdmin

Class for Application admin

« More »

SsoAppliDAOConverter

DAOConverter for SsoAppli

« More »

SsoAuthMethod

SsoAuthMethod

« More »

SsoAuthMethodAdmin

Class for Auth methods admin

« More »

SsoAuthMethodClass

Auth method based on another class (plugin)

« More »

SsoAuthMethodDAOConverter

DAOConverter for AuthMethod

« More »

SsoAuthMethodDatabase

Method based on database

« More »

SsoAuthMethodLdap

Method based on LDAP

« More »

SsoAuthMethodLocal

Local method : will use SSO user table

« More »

SsoClient

Main SSO class

« More »

SsoCredential

SsoCredential

« More »

SsoCredentialAdmin

Class for Credential admin

« More »

SsoCredentialDAOConverter

DAOConverter for Credential

« More »

SsoGroup

SsoGroup

« More »

SsoGroupAdmin

Class for Group admin

« More »

SsoGroupDAOConverter

DAOConverter for Group class

« More »

SsoGroupElement

SsoGroupElement

« More »

SsoGroupableDAOConverter

Parent DAOConverter class for groupable objects

« More »

SsoProfil

SsoProfil class. A Profil is a container for Theme class

« More »

SsoProfilDAOConverter

DAOConverter for SsoProfil

« More »

SsoUser

SsoUser

« More »

SsoUserAdmin

Class for User admin

« More »

SsoUserDAOConverter

DAOConverter for SsoUser

« More »

Theme

Parent class for all themes

« More »

TopbarTheme

Theme for top menu bar

« More »

VisibleTheme

Parent class of all visible theme

« More »

Constants

   

Absolute path of SALT framework

SALT_PATH = '...' 
package sso\config
 

Absolute path of SSO Session store path

SESSION_PATH = '...' 

We use a specific path for session files because some OS (debian and derivated : ubuntu, etc...) use a specific cron script for clean sessions, based on php.ini files. In the SSO, each user can choose the lifetime of the session, but it does not work well if OS clean session files after 30mn...

package sso\config
 

Sso charset

SSO_CHARSET = 'UTF-8' 
package sso\config
 

Current locale for SSO

SSO_CURRENT_LOCALE = 'en' 
package sso\lib
 

Client charset for database as MySQL expected it

SSO_DB_CHARSET = 'utf8' 

It's better if database and website charset are the same, but if not, we have to set here the website charset. MySQL will convert all input/output data to this charset from/to the database charset.

see for how DB charset works
see for supported charsets
package sso\config
 

Database name

SSO_DB_DATABASE = 'database' 
package sso\config
 

Database host name

SSO_DB_HOST = 'localhost' 
package sso\config
 

Database password

SSO_DB_PASS = 'password' 
package sso\config
 

Database port

SSO_DB_PORT = 3306 
package sso\config
 

Database user

SSO_DB_USER = 'root' 
package sso\config
 

Default SSO locale *

SSO_LOCALE = 'en' 
package sso\config
 

Number of elements displayed in autocomplete list

SSO_MAX_AUTOCOMPLETE_ELEMENTS = 8 
package sso\config
 

Number of elements displayed in tooltip

SSO_MAX_TOOLTIP_ELEMENTS = 5 
package sso\config
 

Number of characters required for an autocomplete search

SSO_MIN_AUTOCOMPLETE_CHARACTERS = 2 
package sso\config
 

Relative path of SSO

SSO_RELATIVE = \salt\Salt::relativePath(1) 
package sso\lib
 

SSO page title

SSO_TITLE = $titre 
package sso\lib
 

Last SSO release version

VERSION = '1.1.0' 
package sso