Auth/Adapter/InfoCard.php
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.
- 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
Package: Zend\Auth\Zend\Auth\AdapterA 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
Methods
__construct(string $strXmlDocument) : voidParameters| 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) : stringAdd 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 getCertificatePair(string $key_id) : arrayReturn 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 getPKCipherObject() : \Zend_InfoCard_Cipher_PKI_InterfaceRetrieves the InfoCard public key cipher object being used
Returns| Type | Description |
|---|
| \Zend_InfoCard_Cipher_PKI_Interface | |
getXmlToken() : stringGet the XML Token being processed
Returns| Type | Description |
|---|
| string | The XML token to be processed |
removeCertificatePair(string $key_id) : \Zend_Auth_Adapter_InfoCardRemove 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 |
|---|
ReturnsThrows setPKICipherObject(\Zend_InfoCard_Cipher_PKI_Interface $cipherObj) : \Zend_Auth_Adapter_InfoCardSets the InfoCard public key cipher object to use
Parameters| Name | Type | Description |
|---|
| $cipherObj | \Zend_InfoCard_Cipher_PKI_Interface | |
|---|
Returns setXmlToken(string $strXmlToken) : \Zend_Auth_Adapter_InfoCardSet the XML Token to be processed
Parameters| Name | Type | Description |
|---|
| $strXmlToken | string | The XML token to process |
|---|
Returns 
inherited
Classes
