Class Zend_Auth_Adapter_InfoCard

class Zend_Auth_Adapter_InfoCard implements Zend_Auth_Adapter_Interface

Defined in line 48 of file Auth/Adapter/InfoCard.php.

A Zend_Auth Authentication Adapter allowing the use of Information Cards as an
authentication mechanism

Category	Zend
Package	Zend_Auth
Subpackage	Zend_Auth_Adapter
Copyright	Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
License	http://framework.zend.com/license/new-bsd New BSD License

Overview

Instance fields$_infoCard $_xmlToken

Instance methods__construct() addCertificatePair() authenticate() getAdapter() getCertificatePair() getPKCipherObject() getSymCipherObject() getXmlToken() removeCertificatePair() setAdapter() setPKICipherObject() setSymCipherObject() setXmlToken()

Summary

Instance fields

# $_infoCard	The instance of `Zend_InfoCard`
# $_xmlToken	The XML Token being authenticated

Instance methods

+ __construct()	Constructor
+ addCertificatePair()	Add a Certificate Pair to the list of certificates searched by the component
+ authenticate()	Authenticates the XML token
+ getAdapter()	Retrieves the InfoCard component adapter being used
+ getCertificatePair()	Return a Certificate Pair from a key ID
+ getPKCipherObject()	Retrieves the InfoCard public key cipher object being used
+ getSymCipherObject()	Retrieves the Symmetric cipher object being used
+ getXmlToken()	Get the XML Token being processed
+ removeCertificatePair()	Remove a Certificate Pair by Key ID from the search list
+ setAdapter()	Sets the InfoCard component Adapter to use
+ setPKICipherObject()	Sets the InfoCard public key cipher object to use
+ setSymCipherObject()	Sets the InfoCard symmetric cipher object to use
+ setXmlToken()	Set the XML Token to be processed

Details

Instance fields

$_infoCard

protected $_infoCard

The instance of Zend_InfoCard

Var Zend_InfoCard

Defined in Auth/Adapter/InfoCard.php, line 62

$_xmlToken

protected $_xmlToken

The XML Token being authenticated

Var string

Defined in Auth/Adapter/InfoCard.php, line 55

Instance methods

__construct()

public function __construct( $strXmlDocument)

Constructor

Parameters

string $strXmlDocument The XML Token provided by the client

Returns void

Defined in Auth/Adapter/InfoCard.php, line 70

addCertificatePair()

public function addCertificatePair( $private_key_file $public_key_file $type = Zend_InfoCard_Cipher::ENC_RSA_OAEP_MGF1P $password = null)

Add a Certificate Pair to the list of certificates searched by the component

Parameters

`string $private_key_file`	The path to the private key file for the pair
`string $public_key_file`	The path to the certificate / public key for the pair
`string $type`	(optional) The URI for the type of key pair this is (default RSA with OAEP padding)
`string $password`	(optional) The password for the private key file if necessary

Returns string A key ID representing this key pair in the component

Throws Zend_InfoCard_Exception

Defined in Auth/Adapter/InfoCard.php, line 165

authenticate()

public function authenticate( )

Authenticates the XML token

Returns Zend_Auth_Result The result of the authentication

Defined in Auth/Adapter/InfoCard.php, line 210

getAdapter()

public function getAdapter( )

Retrieves the InfoCard component adapter being used

Returns Zend_InfoCard_Adapter_Interface

Defined in Auth/Adapter/InfoCard.php, line 93

getCertificatePair()

public function getCertificatePair( $key_id)

Return a Certificate Pair from a key ID

Parameters

string $key_id The Key ID of the certificate pair in the component

Returns array An array containing the path to the private/public key files,
the type URI and the password if provided

Throws Zend_InfoCard_Exception

Defined in Auth/Adapter/InfoCard.php, line 178

getPKCipherObject()

public function getPKCipherObject( )

Retrieves the InfoCard public key cipher object being used

Returns Zend_InfoCard_Cipher_PKI_Interface

Defined in Auth/Adapter/InfoCard.php, line 103

getSymCipherObject()

public function getSymCipherObject( )

Retrieves the Symmetric cipher object being used

Returns Zend_InfoCard_Cipher_Symmetric_Interface

Defined in Auth/Adapter/InfoCard.php, line 125

getXmlToken()

public function getXmlToken( )

Get the XML Token being processed

Returns string The XML token to be processed

Defined in Auth/Adapter/InfoCard.php, line 200

removeCertificatePair()

public function removeCertificatePair( $key_id)

Remove a Certificate Pair by Key ID from the search list

Parameters

string $key_id The Certificate Key ID returned from adding the certificate pair

Returns Zend_Auth_Adapter_InfoCard Provides a fluent interface

Throws Zend_InfoCard_Exception

Defined in Auth/Adapter/InfoCard.php, line 149

setAdapter()

public function setAdapter( Zend_InfoCard_Adapter_Interface $a)

Sets the InfoCard component Adapter to use

Parameters

Zend_InfoCard_Adapter_Interface $a

Returns Zend_Auth_Adapter_InfoCard Provides a fluent interface

Defined in Auth/Adapter/InfoCard.php, line 82

setPKICipherObject()

public function setPKICipherObject( Zend_InfoCard_Cipher_PKI_Interface $cipherObj)

Sets the InfoCard public key cipher object to use

Parameters

Zend_InfoCard_Cipher_PKI_Interface $cipherObj

Returns Zend_Auth_Adapter_InfoCard Provides a fluent interface

Defined in Auth/Adapter/InfoCard.php, line 114

setSymCipherObject()

public function setSymCipherObject( Zend_InfoCard_Cipher_Symmetric_Interface $cipherObj)

Sets the InfoCard symmetric cipher object to use

Parameters

Zend_InfoCard_Cipher_Symmetric_Interface $cipherObj

Returns Zend_Auth_Adapter_InfoCard Provides a fluent interface

Defined in Auth/Adapter/InfoCard.php, line 136

setXmlToken()

public function setXmlToken( $strXmlToken)

Set the XML Token to be processed

Parameters

string $strXmlToken The XML token to process

Returns Zend_Auth_Adapter_InfoCard Provides a fluent interface

Defined in Auth/Adapter/InfoCard.php, line 189