Auth/Adapter/InfoCard.php

Show:

inherited

Classes
- \Zend_Auth_Adapter_InfoCard

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Auth
Subpackage: Zend_Auth_Adapter
Version: $Id: InfoCard.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Auth_Adapter_InfoCard
jump to top

Package: Zend\Auth\Zend\Auth\Adapter

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

Implements: \Zend_Auth_Adapter_Interface
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_InfoCard $_infoCard =

The instance of Zend_InfoCard

Details

Type: \Zend_InfoCard

string $_xmlToken =

The XML Token being authenticated

Details

Type: string

Methods

__construct(string $strXmlDocument) : void

Constructor

Parameters

Name	Type	Description
$strXmlDocument	string	The XML Token provided by the client

addCertificatePair(string $private_key_file, string $public_key_file, string $type = \Zend_InfoCard_Cipher::ENC_RSA_OAEP_MGF1P, string $password = null) : string

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

Parameters

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

Returns

Type	Description
string	A key ID representing this key pair in the component

Throws

Exception	Description
\Zend_InfoCard_Exception

authenticate() : \Zend_Auth_Result

Authenticates the XML token

Returns

Type	Description
\Zend_Auth_Result	The result of the authentication

Throws

Exception	Description
\Zend_Auth_Adapter_Exception	If authentication cannot be performed

getAdapter() : \Zend_InfoCard_Adapter_Interface

Retrieves the InfoCard component adapter being used

Returns

Type	Description
\Zend_InfoCard_Adapter_Interface

getCertificatePair(string $key_id) : array

Return a Certificate Pair from a key ID

Parameters

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

Returns

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

Throws

Exception	Description
\Zend_InfoCard_Exception

getPKCipherObject() : \Zend_InfoCard_Cipher_PKI_Interface

Retrieves the InfoCard public key cipher object being used

Returns

Type	Description
\Zend_InfoCard_Cipher_PKI_Interface

getSymCipherObject() : \Zend_InfoCard_Cipher_Symmetric_Interface

Retrieves the Symmetric cipher object being used

Returns

Type	Description
\Zend_InfoCard_Cipher_Symmetric_Interface

getXmlToken() : string

Get the XML Token being processed

Returns

Type	Description
string	The XML token to be processed

removeCertificatePair(string $key_id) : \Zend_Auth_Adapter_InfoCard

Remove a Certificate Pair by Key ID from the search list

Parameters

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

Returns

Type	Description
\Zend_Auth_Adapter_InfoCard	Provides a fluent interface

Throws

Exception	Description
\Zend_InfoCard_Exception

setAdapter(\Zend_InfoCard_Adapter_Interface $a) : \Zend_Auth_Adapter_InfoCard

Sets the InfoCard component Adapter to use

Parameters

Name	Type	Description
$a	\Zend_InfoCard_Adapter_Interface

Returns

Type	Description
\Zend_Auth_Adapter_InfoCard	Provides a fluent interface

setPKICipherObject(\Zend_InfoCard_Cipher_PKI_Interface $cipherObj) : \Zend_Auth_Adapter_InfoCard

Sets the InfoCard public key cipher object to use

Parameters

Name	Type	Description
$cipherObj	\Zend_InfoCard_Cipher_PKI_Interface

Returns

Type	Description
\Zend_Auth_Adapter_InfoCard	Provides a fluent interface

setSymCipherObject(\Zend_InfoCard_Cipher_Symmetric_Interface $cipherObj) : \Zend_Auth_Adapter_InfoCard

Sets the InfoCard symmetric cipher object to use

Parameters

Name	Type	Description
$cipherObj	\Zend_InfoCard_Cipher_Symmetric_Interface

Returns

Type	Description
\Zend_Auth_Adapter_InfoCard	Provides a fluent interface

setXmlToken(string $strXmlToken) : \Zend_Auth_Adapter_InfoCard

Set the XML Token to be processed

Parameters

Name	Type	Description
$strXmlToken	string	The XML token to process

Returns

Type	Description
\Zend_Auth_Adapter_InfoCard	Provides a fluent interface

Auth/Adapter/InfoCard.php

\Zend_Auth_Adapter_InfoCardjump to top

Properties

Methods

\Zend_Auth_Adapter_InfoCard
jump to top