Auth/Adapter/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_Auth
subpackage: Zend_Auth_Adapter
version: $Id: InfoCard.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Auth_Adapter_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_Auth_Adapter_InfoCard
jump to top

Implements: Zend_Auth_Adapter_Interface
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_Auth
subpackage: Zend_Auth_Adapter
Properties: $_xmlToken; $_infoCard
Methods: __construct; setAdapter; getAdapter; getPKCipherObject; setPKICipherObject; getSymCipherObject; setSymCipherObject; removeCertificatePair; addCertificatePair; getCertificatePair; setXmlToken; getXmlToken; authenticate

Description

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

Properties

$_infoCard
jump to class

Zend_InfoCard $_infoCard = ''

The instance of Zend_InfoCard

Details

$_infoCard: Zend_InfoCard
visibility: protected
default
final: false
static: false

$_xmlToken
jump to class

string $_xmlToken = ''

The XML Token being authenticated

Details

$_xmlToken: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $strXmlDocument
          )
        
        :
        void

Constructor

Arguments

$strXmlDocument: string
The XML Token provided by the client

Details

visibility: public
final: false
static: false

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

authenticate
jump to class

authenticate(
          
          )
        
        :
        Zend_Auth_Result

Authenticates the XML token

Output

Zend_Auth_Result: The result of the authentication

Details

visibility: public
final: false
static: false

getAdapter
jump to class

getAdapter(
          
          )
        
        :
        Zend_InfoCard_Adapter_Interface

Retrieves the InfoCard component adapter being used

Output

Zend_InfoCard_Adapter_Interface

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

getPKCipherObject
jump to class

getPKCipherObject(
          
          )
        
        :
        Zend_InfoCard_Cipher_PKI_Interface

Retrieves the InfoCard public key cipher object being used

Output

Zend_InfoCard_Cipher_PKI_Interface

Details

visibility: public
final: false
static: false

getSymCipherObject
jump to class

getSymCipherObject(
          
          )
        
        :
        Zend_InfoCard_Cipher_Symmetric_Interface

Retrieves the Symmetric cipher object being used

Output

Zend_InfoCard_Cipher_Symmetric_Interface

Details

visibility: public
final: false
static: false

getXmlToken
jump to class

getXmlToken(
          
          )
        
        :
        string

Get the XML Token being processed

Output

string: The XML token to be processed

Details

visibility: public
final: false
static: false

removeCertificatePair
jump to class

removeCertificatePair(
          string $key_id
          )
        
        :
        Zend_Auth_Adapter_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_Auth_Adapter_InfoCard: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setAdapter
jump to class

setAdapter(
          Zend_InfoCard_Adapter_Interface $a
          )
        
        :
        Zend_Auth_Adapter_InfoCard

Sets the InfoCard component Adapter to use

Arguments

$a: Zend_InfoCard_Adapter_Interface

Output

Zend_Auth_Adapter_InfoCard: Provides a fluent interface

Details

visibility: public
final: false
static: false

setPKICipherObject
jump to class

setPKICipherObject(
          Zend_InfoCard_Cipher_PKI_Interface $cipherObj
          )
        
        :
        Zend_Auth_Adapter_InfoCard

Sets the InfoCard public key cipher object to use

Arguments

$cipherObj: Zend_InfoCard_Cipher_PKI_Interface

Output

Zend_Auth_Adapter_InfoCard: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSymCipherObject
jump to class

setSymCipherObject(
          Zend_InfoCard_Cipher_Symmetric_Interface $cipherObj
          )
        
        :
        Zend_Auth_Adapter_InfoCard

Sets the InfoCard symmetric cipher object to use

Arguments

$cipherObj: Zend_InfoCard_Cipher_Symmetric_Interface

Output

Zend_Auth_Adapter_InfoCard: Provides a fluent interface

Details

visibility: public
final: false
static: false

setXmlToken
jump to class

setXmlToken(
          string $strXmlToken
          )
        
        :
        Zend_Auth_Adapter_InfoCard

Set the XML Token to be processed

Arguments

$strXmlToken: string
The XML token to process

Output

Zend_Auth_Adapter_InfoCard: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Auth/Adapter/InfoCard.php

Description

Zend_Auth_Adapter_InfoCardjump to top

Description

Properties

$_infoCardjump to class

Details

$_xmlTokenjump to class

Details

Methods

__constructjump to class

Arguments

Details

addCertificatePairjump to class

Arguments

Output

Details

authenticatejump to class

Output

Details

getAdapterjump to class

Output

Details

getCertificatePairjump to class

Arguments

Output

Details

getPKCipherObjectjump to class

Output

Details

getSymCipherObjectjump to class

Output

Details

getXmlTokenjump to class

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

setXmlTokenjump to class

Arguments

Output

Details

Zend_Auth_Adapter_InfoCard
jump to top

$_infoCard
jump to class

$_xmlToken
jump to class

__construct
jump to class

addCertificatePair
jump to class

authenticate
jump to class

getAdapter
jump to class

getCertificatePair
jump to class

getPKCipherObject
jump to class

getSymCipherObject
jump to class

getXmlToken
jump to class

removeCertificatePair
jump to class

setAdapter
jump to class

setPKICipherObject
jump to class

setSymCipherObject
jump to class

setXmlToken
jump to class