API Documentation

InfoCard/Xml/Assertion/Saml.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_InfoCard
subpackage
Zend_InfoCard_Xml
version
$Id: Saml.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_InfoCard_Xml_Assertion_Saml

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_InfoCard_Xml_Assertion_Saml

Extends from
Zend_InfoCard_Xml_Element
Implements
Zend_InfoCard_Xml_Assertion_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_InfoCard
subpackage
Zend_InfoCard_Xml
Constants
CONDITION_AUDIENCE
CONFIRMATION_BEARER
CONDITION_TIME_ADJ
Methods
_getServerName
_getServerPort
validateConditions
getAssertionURI
getMajorVersion
getMinorVersion
getAssertionID
getIssuer
getIssuedTimestamp
getConditions
getSubjectKeyInfo
getConfirmationMethod
getAttributes

Description

A Xml Assertion Document in SAML Token format

Constants

CONDITION_AUDIENCE

 CONDITION_AUDIENCE = 'AudienceRestrictionCondition'

Audience Restriction Condition

Details

value
AudienceRestrictionCondition

CONFIRMATION_BEARER

 CONFIRMATION_BEARER = 'urn:oasis:names:tc:SAML:1.0:cm:bearer'

The URI for a 'bearer' confirmation

Details

value
urn:oasis:names:tc:SAML:1.0:cm:bearer

CONDITION_TIME_ADJ

 CONDITION_TIME_ADJ = '3600'

The amount of time in seconds to buffer when checking conditions to ensure that differences between client/server clocks don't interfer too much

Details

value
3600

Methods

_getServerName

_getServerName( ) :
Details
visibility
protected
final
false
static
false

_getServerPort

_getServerPort( ) :
Details
visibility
protected
final
false
static
false

getAssertionID

getAssertionID( ) : string

Get the Assertion ID of the assertion

Output
string
The Assertion ID
Details
visibility
public
final
false
static
false

getAssertionURI

getAssertionURI( ) : string

Get the Assertion URI for this type of Assertion

Output
string
the Assertion URI
Details
visibility
public
final
false
static
false

getAttributes

getAttributes( ) : array

Return an array of attributes (claims) contained within the assertion

Output
array
An array of attributes / claims within the assertion
Details
visibility
public
final
false
static
false

getConditions

getConditions( ) : array

Return an array of conditions which the assertions are predicated on

Output
array
an array of conditions
Details
visibility
public
final
false
static
false
throws

getConfirmationMethod

getConfirmationMethod( ) : string

Return the Confirmation Method URI used in the Assertion

Output
string
The confirmation method URI
Details
visibility
public
final
false
static
false

getIssuedTimestamp

getIssuedTimestamp( ) : integer

Get the Timestamp of when the assertion was issued

Output
integer
a UNIX timestamp representing when the assertion was issued
Details
visibility
public
final
false
static
false

getIssuer

getIssuer( ) : string

Get the Issuer URI of the assertion

Output
string
the URI of the assertion Issuer
Details
visibility
public
final
false
static
false

getMajorVersion

getMajorVersion( ) : integer

Get the Major Version of the SAML Assertion

Output
integer
The major version number
Details
visibility
public
final
false
static
false

getMinorVersion

getMinorVersion( ) : integer

The Minor Version of the SAML Assertion

Output
integer
The minor version number
Details
visibility
public
final
false
static
false

getSubjectKeyInfo

getSubjectKeyInfo( ) :

Get they KeyInfo element for the Subject KeyInfo block

Details
visibility
public
final
false
static
false
ignore
todo
Not Yet Implemented

validateConditions

validateConditions( array $conditions ) : mixed

Validate the conditions array returned from the getConditions() call

Arguments
$conditions
array
An array of condtions for the assertion taken from getConditions()
Output
mixed
Boolean true on success, an array of condition, error message on failure
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.