Auth/Adapter/Http.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_Http
version: $Id: Http.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Auth_Adapter_Http

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_Http
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_Http
todo: Support auth-int
todo: Track nonces, nonce-count, opaque for replay protection and stale support
todo: Support Authentication-Info header
Properties: $_request; $_response; $_basicResolver; $_digestResolver; $_supportedSchemes; $_acceptSchemes; $_domains; $_realm; $_nonceTimeout; $_useOpaque; $_supportedAlgos; $_algo; $_supportedQops; $_imaProxy; $_ieNoOpaque
Methods: __construct; setBasicResolver; getBasicResolver; setDigestResolver; getDigestResolver; setRequest; getRequest; setResponse; getResponse; authenticate; _challengeClient; _basicHeader; _digestHeader; _basicAuth; _digestAuth; _calcNonce; _calcOpaque; _parseDigestAuth

Description

HTTP Authentication Adapter

Implements a pretty good chunk of RFC 2617.

Properties

$_acceptSchemes
jump to class

array $_acceptSchemes = ''

List of schemes this class will accept from the client

Details

$_acceptSchemes: array
visibility: protected
default
final: false
static: false

$_algo
jump to class

string $_algo = ''

The actual algorithm to use. Defaults to MD5

Details

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

$_basicResolver
jump to class

Zend_Auth_Adapter_Http_Resolver_Interface $_basicResolver = ''

Object that looks up user credentials for the Basic scheme

Details

$_basicResolver: Zend_Auth_Adapter_Http_Resolver_Interface
visibility: protected
default
final: false
static: false

$_digestResolver
jump to class

Zend_Auth_Adapter_Http_Resolver_Interface $_digestResolver = ''

Object that looks up user credentials for the Digest scheme

Details

$_digestResolver: Zend_Auth_Adapter_Http_Resolver_Interface
visibility: protected
default
final: false
static: false

$_domains
jump to class

string $_domains = ''

Space-delimited list of protected domains for Digest Auth

Details

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

$_ieNoOpaque
jump to class

boolean $_ieNoOpaque = ''

Flag indicating the client is IE and didn't bother to return the opaque string

Details

$_ieNoOpaque: boolean
visibility: protected
default
final: false
static: false

$_imaProxy
jump to class

boolean $_imaProxy = ''

Whether or not to do Proxy Authentication instead of origin server authentication (send 407's instead of 401's). Off by default.

Details

$_imaProxy: boolean
visibility: protected
default
final: false
static: false

$_nonceTimeout
jump to class

integer $_nonceTimeout = ''

Nonce timeout period

Details

$_nonceTimeout: integer
visibility: protected
default
final: false
static: false

$_realm
jump to class

string $_realm = ''

The protection realm to use

Details

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

$_request
jump to class

Zend_Controller_Request_Http $_request = ''

Reference to the HTTP Request object

Details

$_request: Zend_Controller_Request_Http
visibility: protected
default
final: false
static: false

$_response
jump to class

Zend_Controller_Response_Http $_response = ''

Reference to the HTTP Response object

Details

$_response: Zend_Controller_Response_Http
visibility: protected
default
final: false
static: false

$_supportedAlgos
jump to class

array $_supportedAlgos = 'array'

List of the supported digest algorithms. I want to support both MD5 and MD5-sess, but MD5-sess won't make it into the first version.

Details

$_supportedAlgos: array
visibility: protected
default: array
final: false
static: false

$_supportedQops
jump to class

array $_supportedQops = 'array'

List of supported qop options. My intetion is to support both 'auth' and 'auth-int', but 'auth-int' won't make it into the first version.

Details

$_supportedQops: array
visibility: protected
default: array
final: false
static: false

$_supportedSchemes
jump to class

array $_supportedSchemes = 'array'

List of authentication schemes supported by this class

Details

$_supportedSchemes: array
visibility: protected
default: array
final: false
static: false

$_useOpaque
jump to class

boolean $_useOpaque = ''

Whether to send the opaque value in the header. True by default

Details

$_useOpaque: boolean
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $config
          )
        
        :
        void

Constructor

Arguments

$config: array
Configuration settings: 'accept_schemes' => 'basic'|'digest'|'basic digest' 'realm' => <string> 'digest_domains' => <string> Space-delimited list of URIs 'nonce_timeout' => <int> 'use_opaque' => <bool> Whether to send the opaque value in the header 'alogrithm' => <string> See $_supportedAlgos. Default: MD5 'proxy_auth' => <bool> Whether to do authentication as a Proxy

Details

visibility: public
final: false
static: false
throws

_basicAuth
jump to class

_basicAuth(
          string $header
          )
        
        :
        Zend_Auth_Result

Basic Authentication

Arguments

$header: string
Client's Authorization header

Output

Zend_Auth_Result

Details

visibility: protected
final: false
static: false
throws

_basicHeader
jump to class

_basicHeader(
          
          )
        
        :
        string

Basic Header

Generates a Proxy- or WWW-Authenticate header value in the Basic authentication scheme.

Output

string: Authenticate header value

Details

visibility: protected
final: false
static: false

_calcNonce
jump to class

_calcNonce(
          
          )
        
        :
        string

Calculate Nonce

Output

string: The nonce value

Details

visibility: protected
final: false
static: false

_calcOpaque
jump to class

_calcOpaque(
          
          )
        
        :
        string

Calculate Opaque

The opaque string can be anything; the client must return it exactly as it was sent. It may be useful to store data in this string in some applications. Ideally, a new value for this would be generated each time a WWW-Authenticate header is sent (in order to reduce predictability), but we would have to be able to create the same exact value across at least two separate requests from the same client.

Output

string: The opaque value

Details

visibility: protected
final: false
static: false

_challengeClient
jump to class

_challengeClient(
          
          )
        
        :
        Zend_Auth_Result

Challenge Client

Sets a 401 or 407 Unauthorized response code, and creates the appropriate Authenticate header(s) to prompt for credentials.

Output

Zend_Auth_Result: Always returns a non-identity Auth result

Details

visibility: protected
final: false
static: false

_digestAuth
jump to class

_digestAuth(
          string $header
          )
        
        :
        Zend_Auth_Result

Digest Authentication

Arguments

$header: string
Client's Authorization header

Output

Zend_Auth_Result: Valid auth result only on successful auth

Details

visibility: protected
final: false
static: false
throws

_digestHeader
jump to class

_digestHeader(
          
          )
        
        :
        string

Digest Header

Generates a Proxy- or WWW-Authenticate header value in the Digest authentication scheme.

Output

string: Authenticate header value

Details

visibility: protected
final: false
static: false

_parseDigestAuth
jump to class

_parseDigestAuth(
          string $header
          )
        
        :
        array|false

Parse Digest Authorization header

Arguments

$header: string
Client's Authorization: HTTP header

Output

array|false: Data elements from header, or false if any part of the header is invalid

Details

visibility: protected
final: false
static: false

authenticate
jump to class

authenticate(
          
          )
        
        :
        Zend_Auth_Result

Authenticate

Output

Zend_Auth_Result

Details

visibility: public
final: false
static: false
throws

getBasicResolver
jump to class

getBasicResolver(
          
          )
        
        :
        Zend_Auth_Adapter_Http_Resolver_Interface

Getter for the _basicResolver property

Output

Zend_Auth_Adapter_Http_Resolver_Interface

Details

visibility: public
final: false
static: false

getDigestResolver
jump to class

getDigestResolver(
          
          )
        
        :
        Zend_Auth_Adapter_Http_Resolver_Interface

Getter for the _digestResolver property

Output

Zend_Auth_Adapter_Http_Resolver_Interface

Details

visibility: public
final: false
static: false

getRequest
jump to class

getRequest(
          
          )
        
        :
        Zend_Controller_Request_Http

Getter for the Request object

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Controller_Response_Http

Getter for the Response object

Output

Zend_Controller_Response_Http

Details

visibility: public
final: false
static: false

setBasicResolver
jump to class

setBasicResolver(
          Zend_Auth_Adapter_Http_Resolver_Interface $resolver
          )
        
        :
        Zend_Auth_Adapter_Http

Setter for the _basicResolver property

Arguments

$resolver: Zend_Auth_Adapter_Http_Resolver_Interface

Output

Zend_Auth_Adapter_Http: Provides a fluent interface

Details

visibility: public
final: false
static: false

setDigestResolver
jump to class

setDigestResolver(
          Zend_Auth_Adapter_Http_Resolver_Interface $resolver
          )
        
        :
        Zend_Auth_Adapter_Http

Setter for the _digestResolver property

Arguments

$resolver: Zend_Auth_Adapter_Http_Resolver_Interface

Output

Zend_Auth_Adapter_Http: Provides a fluent interface

Details

visibility: public
final: false
static: false

setRequest
jump to class

setRequest(
          Zend_Controller_Request_Http $request
          )
        
        :
        Zend_Auth_Adapter_Http

Setter for the Request object

Arguments

$request: Zend_Controller_Request_Http

Output

Zend_Auth_Adapter_Http: Provides a fluent interface

Details

visibility: public
final: false
static: false

setResponse
jump to class

setResponse(
          Zend_Controller_Response_Http $response
          )
        
        :
        Zend_Auth_Adapter_Http

Setter for the Response object

Arguments

$response: Zend_Controller_Response_Http

Output

Zend_Auth_Adapter_Http: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Auth/Adapter/Http.php

Description

Zend_Auth_Adapter_Httpjump to top

Description

Properties

$_acceptSchemesjump to class

Details

$_algojump to class

Details

$_basicResolverjump to class

Details

$_digestResolverjump to class

Details

$_domainsjump to class

Details

$_ieNoOpaquejump to class

Details

$_imaProxyjump to class

Details

$_nonceTimeoutjump to class

Details

$_realmjump to class

Details

$_requestjump to class

Details

$_responsejump to class

Details

$_supportedAlgosjump to class

Details

$_supportedQopsjump to class

Details

$_supportedSchemesjump to class

Details

$_useOpaquejump to class

Details

Methods

__constructjump to class

Arguments

Details

_basicAuthjump to class

Arguments

Output

Details

_basicHeaderjump to class

Output

Details

_calcNoncejump to class

Output

Details

_calcOpaquejump to class

Output

Details

_challengeClientjump to class

Output

Details

_digestAuthjump to class

Arguments

Output

Details

_digestHeaderjump to class

Output

Details

_parseDigestAuthjump to class

Arguments

Output

Details

authenticatejump to class

Output

Details

getBasicResolverjump to class

Output

Details

getDigestResolverjump to class

Output

Details

getRequestjump to class

Output

Details

getResponsejump to class

Zend_Auth_Adapter_Http
jump to top

$_acceptSchemes
jump to class

$_algo
jump to class

$_basicResolver
jump to class

$_digestResolver
jump to class

$_domains
jump to class

$_ieNoOpaque
jump to class

$_imaProxy
jump to class

$_nonceTimeout
jump to class

$_realm
jump to class

$_request
jump to class

$_response
jump to class

$_supportedAlgos
jump to class

$_supportedQops
jump to class

$_supportedSchemes
jump to class

$_useOpaque
jump to class

__construct
jump to class

_basicAuth
jump to class

_basicHeader
jump to class

_calcNonce
jump to class

_calcOpaque
jump to class

_challengeClient
jump to class

_digestAuth
jump to class

_digestHeader
jump to class

_parseDigestAuth
jump to class

authenticate
jump to class

getBasicResolver
jump to class

getDigestResolver
jump to class

getRequest
jump to class

getResponse
jump to class

setBasicResolver
jump to class

setDigestResolver
jump to class

setRequest
jump to class

setResponse
jump to class