Detailed Description
Definition at line 58 of file InfoCard.php.
Constructor & Destructor Documentation
InfoCard Constructor
- Exceptions:
-
Definition at line 101 of file InfoCard.php.
Member Function Documentation
_extractSignedToken |
( |
$ |
strXmlToken ) |
[protected] |
Extracts the Signed Token from an EncryptedData block
- Exceptions:
-
- Parameters:
-
string | $strXmlToken | The EncryptedData XML block |
- Returns:
- string The XML of the Signed Token inside of the EncryptedData block
Definition at line 337 of file InfoCard.php.
_findCertifiatePairByDigest |
( |
$ |
digest, |
|
|
$ |
digestMethod = self::DIGEST_SHA1 |
|
) |
| [protected] |
Find a certificate pair based on a digest of its public key / certificate file
- Parameters:
-
string | $digest | The digest value of the public key wanted in binary form |
string | $digestMethod | The URI of the digest method used to calculate the digest |
- Returns:
- mixed The Key ID of the matching certificate pair or false if not found
Definition at line 315 of file InfoCard.php.
_getPublicKeyDigest |
( |
$ |
key_id, |
|
|
$ |
digestMethod = self::DIGEST_SHA1 |
|
) |
| [protected] |
Retrieve the digest of a given public key / certificate using the provided digest method
- Exceptions:
-
- Parameters:
-
string | $key_id | The certificate key id in the component |
string | $digestMethod | The URI of the digest method to use (default SHA1) |
- Returns:
- string The digest value in binary format
Definition at line 287 of file InfoCard.php.
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
- Exceptions:
-
- 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
Definition at line 218 of file InfoCard.php.
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
- Returns:
- Zend_InfoCard_Adapter_Interface The Adapter instance
Definition at line 135 of file InfoCard.php.
getCertificatePair |
( |
$ |
key_id ) |
|
Return a Certificate Pair from a key ID
- Exceptions:
-
- 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
Definition at line 268 of file InfoCard.php.
Gets the Public Key Cipher object used in this instance
- Returns:
- Zend_InfoCard_Cipher_Pki_Interface
Definition at line 150 of file InfoCard.php.
Get the Symmetric Cipher Object used in this instance
- Returns:
- Zend_InfoCard_Cipher_Symmetric_Interface
Definition at line 172 of file InfoCard.php.
process |
( |
$ |
strXmlToken ) |
|
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
- Parameters:
-
string | $strXmlToken | The XML token sent to the server from the client |
- Returns:
- Zend_Infocard_Claims The Claims object containing the claims, or any errors which occurred
Definition at line 427 of file InfoCard.php.
removeCertificatePair |
( |
$ |
key_id ) |
|
Remove a Certificate Pair by Key ID from the search list
- Exceptions:
-
- Parameters:
-
string | $key_id | The Certificate Key ID returned from adding the certificate pair |
- Returns:
- Zend_InfoCard
Definition at line 196 of file InfoCard.php.
setAdapter |
( |
Zend_InfoCard_Adapter_Interface $ |
a ) |
|
Sets the adapter uesd for callbacks into the application using the component, used when doing things such as storing / retrieving assertions, etc.
- Parameters:
-
Zend_InfoCard_Adapter_Interface | $a | The Adapter instance |
- Returns:
- Zend_InfoCard The instnace
Definition at line 123 of file InfoCard.php.
setPkiCipherObject |
( |
Zend_InfoCard_Cipher_Pki_Interface $ |
cipherObj ) |
|
Sets the Public Key Cipher Object used in this instance
- Parameters:
-
Zend_InfoCard_Cipher_Pki_Interface | $cipherObj | |
- Returns:
- Zend_InfoCard
Definition at line 161 of file InfoCard.php.
setSymCipherObject |
( |
$ |
cipherObj ) |
|
Sets the Symmetric Cipher Object used in this instance
- Parameters:
-
Zend_InfoCard_Cipher_Symmetric_Interface | $cipherObj | |
- Returns:
- Zend_InfoCard
Definition at line 183 of file InfoCard.php.
Field Documentation
const DIGEST_SHA1 = 'http://www.w3.org/2000/09/xmldsig#sha1' |
URI for XML Digital Signature SHA1 Digests
Definition at line 63 of file InfoCard.php.
The documentation for this class was generated from the following file: