InfoCard.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_InfoCard
version: $Id: InfoCard.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_InfoCard

Description

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.

Zend_InfoCard
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_InfoCard
Constants: DIGEST_SHA1
Properties: $_keyPairs; $_pkiCipherObj; $_symCipherObj; $_adapter
Methods: __construct; setAdapter; getAdapter; getPkiCipherObject; setPkiCipherObject; getSymCipherObject; setSymCipherObject; removeCertificatePair; addCertificatePair; getCertificatePair; _getPublicKeyDigest; _findCertifiatePairByDigest; _extractSignedToken; process

Description

Constants

DIGEST_SHA1
jump to class

 DIGEST_SHA1 = 'http://www.w3.org/2000/09/xmldsig#sha1'

URI for XML Digital Signature SHA1 Digests

Details

value: http://www.w3.org/2000/09/xmldsig#sha1

Properties

$_adapter
jump to class

Zend_InfoCard_Adapter_Interface $_adapter = ''

The InfoCard Adapter to use for callbacks into the application using the component such as when storing assertions, etc.

Details

$_adapter: Zend_InfoCard_Adapter_Interface
visibility: protected
default
final: false
static: false

$_keyPairs
jump to class

Array $_keyPairs = ''

An array of certificate pair files and optional passwords for them to search when trying to determine which certificate was used to encrypt the transient key

Details

$_keyPairs: Array
visibility: protected
default
final: false
static: false

$_pkiCipherObj
jump to class

Zend_InfoCard_Cipher_Pki_Interface $_pkiCipherObj = ''

The instance to use to decrypt public-key encrypted data

Details

$_pkiCipherObj: Zend_InfoCard_Cipher_Pki_Interface
visibility: protected
default
final: false
static: false

$_symCipherObj
jump to class

Zend_InfoCard_Cipher_Symmetric_Interface $_symCipherObj = ''

The instance to use to decrypt symmetric encrypted data

Details

$_symCipherObj: Zend_InfoCard_Cipher_Symmetric_Interface
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

InfoCard Constructor

Details

visibility: public
final: false
static: false
throws

_extractSignedToken
jump to class

_extractSignedToken(
          string $strXmlToken
          )
        
        :
        string

Extracts the Signed Token from an EncryptedData block

Arguments

$strXmlToken: string
The EncryptedData XML block

Output

string: The XML of the Signed Token inside of the EncryptedData block

Details

visibility: protected
final: false
static: false
throws

_findCertifiatePairByDigest
jump to class

_findCertifiatePairByDigest(
          string $digest, string $digestMethod
              =
              self
          )
        
        :
        mixed

Find a certificate pair based on a digest of its public key / certificate file

Arguments

$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

Output

mixed: The Key ID of the matching certificate pair or false if not found

Details

visibility: protected
final: false
static: false

_getPublicKeyDigest
jump to class

_getPublicKeyDigest(
          string $key_id, string $digestMethod
              =
              self
          )
        
        :
        string

Retrieve the digest of a given public key / certificate using the provided digest method

Arguments

$key_id: string
The certificate key id in the component
$digestMethod: string
The URI of the digest method to use (default SHA1)

Output

string: The digest value in binary format

Details

visibility: protected
final: false
static: false
throws

addCertificatePair
jump to class

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

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

Arguments

$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

Output

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

Details

visibility: public
final: false
static: false
throws

getAdapter
jump to class

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

Output

Zend_InfoCard_Adapter_Interface: The Adapter instance

Details

visibility: public
final: false
static: false

getCertificatePair
jump to class

getCertificatePair(
          string $key_id
          )
        
        :
        array

Return a Certificate Pair from a key ID

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws

getPkiCipherObject
jump to class

getPkiCipherObject(
          
          )
        
        :
        Zend_InfoCard_Cipher_Pki_Interface

Gets the Public Key Cipher object used in this instance

Output

Zend_InfoCard_Cipher_Pki_Interface

Details

visibility: public
final: false
static: false

getSymCipherObject
jump to class

getSymCipherObject(
          
          )
        
        :
        Zend_InfoCard_Cipher_Symmetric_Interface

Get the Symmetric Cipher Object used in this instance

Output

Zend_InfoCard_Cipher_Symmetric_Interface

Details

visibility: public
final: false
static: false

process
jump to class

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

Arguments

$strXmlToken: string
The XML token sent to the server from the client

Output

Zend_Infocard_Claims: The Claims object containing the claims, or any errors which occurred

Details

visibility: public
final: false
static: false

removeCertificatePair
jump to class

removeCertificatePair(
          string $key_id
          )
        
        :
        Zend_InfoCard

Remove a Certificate Pair by Key ID from the search list

Arguments

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

Output

Zend_InfoCard

Details

visibility: public
final: false
static: false
throws

setAdapter
jump to class

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.

Arguments

$a: Zend_InfoCard_Adapter_Interface
The Adapter instance

Output

Zend_InfoCard: The instnace

Details

visibility: public
final: false
static: false

setPkiCipherObject
jump to class

setPkiCipherObject(
          Zend_InfoCard_Cipher_Pki_Interface $cipherObj
          )
        
        :
        Zend_InfoCard

Sets the Public Key Cipher Object used in this instance

Arguments

$cipherObj: Zend_InfoCard_Cipher_Pki_Interface

Output

Zend_InfoCard

Details

visibility: public
final: false
static: false

setSymCipherObject
jump to class

setSymCipherObject(
          Zend_InfoCard_Cipher_Symmetric_Interface $cipherObj
          )
        
        :
        Zend_InfoCard

Sets the Symmetric Cipher Object used in this instance

Arguments

$cipherObj: Zend_InfoCard_Cipher_Symmetric_Interface

Output

Zend_InfoCard

Details

visibility: public
final: false
static: false

API Documentation

InfoCard.php

Description

Zend_InfoCardjump to top

Description

Constants

DIGEST_SHA1jump to class

Details

Properties

$_adapterjump to class

Details

$_keyPairsjump to class

Details

$_pkiCipherObjjump to class

Details

$_symCipherObjjump to class

Details

Methods

__constructjump to class

Details

_extractSignedTokenjump to class

Arguments

Output

Details

_findCertifiatePairByDigestjump to class

Arguments

Output

Details

_getPublicKeyDigestjump to class

Arguments

Output

Details

addCertificatePairjump to class

Arguments

Output

Details

getAdapterjump to class

Output

Details

getCertificatePairjump to class

Arguments

Output

Details

getPkiCipherObjectjump to class

Output

Details

getSymCipherObjectjump to class

Output

Details

processjump to class

Arguments

Output

Details

removeCertificatePairjump to class

Arguments

Output

Details

setAdapterjump to class

Arguments

Output

Details

setPkiCipherObjectjump to class

Arguments

Output

Details

setSymCipherObjectjump to class

Arguments

Output

Details

Zend_InfoCard
jump to top

DIGEST_SHA1
jump to class

$_adapter
jump to class

$_keyPairs
jump to class

$_pkiCipherObj
jump to class

$_symCipherObj
jump to class

__construct
jump to class

_extractSignedToken
jump to class

_findCertifiatePairByDigest
jump to class

_getPublicKeyDigest
jump to class

addCertificatePair
jump to class

getAdapter
jump to class

getCertificatePair
jump to class

getPkiCipherObject
jump to class

getSymCipherObject
jump to class

process
jump to class

removeCertificatePair
jump to class

setAdapter
jump to class

setPkiCipherObject
jump to class

setSymCipherObject
jump to class