InfoCard.php
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_InfoCard
- Version
- $Id: InfoCard.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_InfoCard
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


\Zend_InfoCard_Adapter_Interface $_adapter


Array $_keyPairs
- Type
- Array


\Zend_InfoCard_Cipher_Pki_Interface $_pkiCipherObj
Methods


_extractSignedToken(string $strXmlToken) : string
Extracts the Signed Token from an EncryptedData block
Name | Type | Description |
---|---|---|
$strXmlToken | string | The EncryptedData XML block |
Type | Description |
---|---|
string | The XML of the Signed Token inside of the EncryptedData block |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |


_findCertifiatePairByDigest(string $digest, string $digestMethod = self::DIGEST_SHA1) : mixed
Find a certificate pair based on a digest of its public key / certificate file
Name | Type | Description |
---|---|---|
$digest | string | The digest value of the public key wanted in binary form |
$digestMethod | string | The URI of the digest method used to calculate the digest |
Type | Description |
---|---|
mixed | The Key ID of the matching certificate pair or false if not found |


_getPublicKeyDigest(string $key_id, string $digestMethod = self::DIGEST_SHA1) : string
Retrieve the digest of a given public key / certificate using the provided digest method
Name | Type | Description |
---|---|---|
$key_id | string | The certificate key id in the component |
$digestMethod | string | The URI of the digest method to use (default SHA1) |
Type | Description |
---|---|
string | The digest value in binary format |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |


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
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 |
Type | Description |
---|---|
string | A key ID representing this key pair in the component |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |


getAdapter() : \Zend_InfoCard_Adapter_Interface
Retrieves the adapter used for callbacks into the application using the component.
If no adapter was set then an instance of Zend_InfoCard_Adapter_Default is used
Type | Description |
---|---|
\Zend_InfoCard_Adapter_Interface | The Adapter instance |


getCertificatePair(string $key_id) : array
Return a Certificate Pair from a key ID
Name | Type | Description |
---|---|---|
$key_id | string | The Key ID of the certificate pair in the component |
Type | Description |
---|---|
array | An array containing the path to the private/public key files, the type URI and the password if provided |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |


getPkiCipherObject() : \Zend_InfoCard_Cipher_Pki_Interface
Gets the Public Key Cipher object used in this instance
Type | Description |
---|---|
\Zend_InfoCard_Cipher_Pki_Interface |


getSymCipherObject() : \Zend_InfoCard_Cipher_Symmetric_Interface
Get the Symmetric Cipher Object used in this instance
Type | Description |
---|---|
\Zend_InfoCard_Cipher_Symmetric_Interface |


process(string $strXmlToken) : \Zend_Infocard_Claims
Process an input Infomation Card EncryptedData block sent from the client, validate it, and return the claims contained within it on success or an error message on error
Name | Type | Description |
---|---|---|
$strXmlToken | string | The XML token sent to the server from the client |
Type | Description |
---|---|
\Zend_Infocard_Claims | The Claims object containing the claims, or any errors which occurred |


removeCertificatePair(string $key_id) : \Zend_InfoCard
Remove a Certificate Pair by Key ID from the search list
Name | Type | Description |
---|---|---|
$key_id | string | The Certificate Key ID returned from adding the certificate pair |
Type | Description |
---|---|
\Zend_InfoCard |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |


setAdapter(\Zend_InfoCard_Adapter_Interface $a) : \Zend_InfoCard
Sets the adapter uesd for callbacks into the application using the component, used when doing things such as storing / retrieving assertions, etc.
Name | Type | Description |
---|---|---|
$a | \Zend_InfoCard_Adapter_Interface | The Adapter instance |
Type | Description |
---|---|
\Zend_InfoCard | The instnace |


setPkiCipherObject(\Zend_InfoCard_Cipher_Pki_Interface $cipherObj) : \Zend_InfoCard
Sets the Public Key Cipher Object used in this instance
Name | Type | Description |
---|---|---|
$cipherObj | \Zend_InfoCard_Cipher_Pki_Interface |
Type | Description |
---|---|
\Zend_InfoCard |


setSymCipherObject(\Zend_InfoCard_Cipher_Symmetric_Interface $cipherObj) : \Zend_InfoCard
Sets the Symmetric Cipher Object used in this instance
Name | Type | Description |
---|---|---|
$cipherObj | \Zend_InfoCard_Cipher_Symmetric_Interface |
Type | Description |
---|---|
\Zend_InfoCard |