• Home
  • OneLogin_Saml2_Settings

PHP Class OneLogin_Saml2_Settings

Mostra file Open project: onelogin/php-saml Class Usage Examples

Public Methods

Method Description
__construct ( array | object | null $settings = null, $spValidationOnly = false ) Initializes the settings: - Sets the paths of the different folders - Loads settings info from settings file or array/object provided
checkCompressionSettings ( array $settings ) : array Checks the compression settings info.
checkIdPSettings ( array $settings ) : array Checks the IdP settings info.
checkSPCerts ( ) : boolean Checks if the x509 certs of the SP exists and are valid.
checkSPSettings ( array $settings ) : array Checks the SP settings info.
checkSettings ( array $settings ) : array Checks the settings info.
formatIdPCert ( ) Formats the IdP cert.
formatSPCert ( ) Formats the SP cert.
formatSPKey ( ) Formats the SP private key.
getBasePath ( ) : string Returns base path.
getBaseURL ( ) : null | string Returns the baseurl set on the settings if any.
getCertPath ( ) : string Returns cert path.
getConfigPath ( ) : string Returns config path.
getContacts ( ) : array Gets contact data.
getErrors ( ) : array Returns an array with the errors, the array is empty when the settings is ok.
getExtLibPath ( ) : string Returns external lib path.
getIdPData ( ) : array Gets the IdP data.
getLibPath ( ) : string Returns lib path.
getOrganization ( ) : array Gets organization data.
getSPData ( ) : array Gets the SP data.
getSPMetadata ( ) : string Gets the SP metadata. The XML representation.
getSPcert ( ) : string Returns the x509 public cert of the SP.
getSPkey ( ) : string Returns the x509 private key of the SP.
getSchemasPath ( ) : string Returns schema path.
getSecurityData ( ) : array Gets security data.
isDebugActive ( ) : boolean Returns if the debug is active.
isStrict ( ) : boolean Returns if the 'strict' mode is active.
setBaseURL ( $baseurl ) Set a baseurl value.
setIdPCert ( $cert ) Sets the IdP certificate.
setStrict ( boolean $value ) Activates or deactivates the strict mode.
shouldCompressRequests ( ) : boolean Should SAML requests be compressed?
shouldCompressResponses ( ) : boolean Should SAML responses be compressed?
validateMetadata ( string $xml ) : Array Validates an XML SP Metadata.

Private Methods

Method Description
_addDefaultValues ( ) Add default values if the settings info is not complete
_loadPaths ( ) Sets the paths of the different folders
_loadSettingsFromArray ( array $settings ) : boolean Loads settings info from a settings Array
_loadSettingsFromFile ( ) : boolean Loads settings info from the settings file

Method Details

__construct() public method

Initializes the settings: - Sets the paths of the different folders - Loads settings info from settings file or array/object provided
public __construct ( array | object | null $settings = null, $spValidationOnly = false )
$settings array | object | null SAML Toolkit Settings

checkCompressionSettings() public method

Checks the compression settings info.
public checkCompressionSettings ( array $settings ) : array
$settings array Array with settings data
return array $errors Errors found on the settings data

checkIdPSettings() public method

Checks the IdP settings info.
public checkIdPSettings ( array $settings ) : array
$settings array Array with settings data
return array $errors Errors found on the IdP settings data

checkSPCerts() public method

Checks if the x509 certs of the SP exists and are valid.
public checkSPCerts ( ) : boolean
return boolean

checkSPSettings() public method

Checks the SP settings info.
public checkSPSettings ( array $settings ) : array
$settings array Array with settings data
return array $errors Errors found on the SP settings data

checkSettings() public method

Checks the settings info.
public checkSettings ( array $settings ) : array
$settings array Array with settings data
return array $errors Errors found on the settings data

formatIdPCert() public method

Formats the IdP cert.
public formatIdPCert ( )

formatSPCert() public method

Formats the SP cert.
public formatSPCert ( )

formatSPKey() public method

Formats the SP private key.
public formatSPKey ( )

getBasePath() public method

Returns base path.
public getBasePath ( ) : string
return string The base toolkit folder path

getBaseURL() public method

Returns the baseurl set on the settings if any.
public getBaseURL ( ) : null | string
return null | string The baseurl

getCertPath() public method

Returns cert path.
public getCertPath ( ) : string
return string The cert folder path

getConfigPath() public method

Returns config path.
public getConfigPath ( ) : string
return string The config folder path

getContacts() public method

Gets contact data.
public getContacts ( ) : array
return array SP info

getErrors() public method

Returns an array with the errors, the array is empty when the settings is ok.
public getErrors ( ) : array
return array Errors

getExtLibPath() public method

Returns external lib path.
public getExtLibPath ( ) : string
return string The external library folder path

getIdPData() public method

Gets the IdP data.
public getIdPData ( ) : array
return array IdP info

getLibPath() public method

Returns lib path.
public getLibPath ( ) : string
return string The library folder path

getOrganization() public method

Gets organization data.
public getOrganization ( ) : array
return array SP info

getSPData() public method

Gets the SP data.
public getSPData ( ) : array
return array SP info

getSPMetadata() public method

Gets the SP metadata. The XML representation.
public getSPMetadata ( ) : string
return string SP metadata (xml)

getSPcert() public method

Returns the x509 public cert of the SP.
public getSPcert ( ) : string
return string SP public cert

getSPkey() public method

Returns the x509 private key of the SP.
public getSPkey ( ) : string
return string SP private key

getSchemasPath() public method

Returns schema path.
public getSchemasPath ( ) : string
return string The external library folder path

getSecurityData() public method

Gets security data.
public getSecurityData ( ) : array
return array SP info

isDebugActive() public method

Returns if the debug is active.
public isDebugActive ( ) : boolean
return boolean Debug parameter

isStrict() public method

Returns if the 'strict' mode is active.
public isStrict ( ) : boolean
return boolean Strict parameter

setBaseURL() public method

Set a baseurl value.
public setBaseURL ( $baseurl )

setIdPCert() public method

Sets the IdP certificate.
public setIdPCert ( $cert )

setStrict() public method

Activates or deactivates the strict mode.
public setStrict ( boolean $value )
$value boolean Strict parameter

shouldCompressRequests() public method

Should SAML requests be compressed?
public shouldCompressRequests ( ) : boolean
return boolean Yes/No as True/False

shouldCompressResponses() public method

Should SAML responses be compressed?
public shouldCompressResponses ( ) : boolean
return boolean Yes/No as True/False

validateMetadata() public method

Validates an XML SP Metadata.
public validateMetadata ( string $xml ) : Array
$xml string Metadata's XML that will be validate
return Array The list of found errors